MCP tools

List promo windows

Lists the active brand's promo windows, the sales the user entered in Koast: name, first and last day, how many days of aftermath follow, and whether each is coming up, running, in its aftermath or over.

Tool name: list-promo-windows.

Lists the active brand's promo windows, the sales the user entered in Koast: name, first and last day, how many days of aftermath follow, and whether each is coming up, running, in its aftermath or over. Read-only.

When to use

Before judging a spike or a dip in results, to check whether a planned sale or the quiet days after it explain it.

Access

PropertyValue
Required scoperead
PublishesNo
Read-onlyYes
DestructiveNo
IdempotentYes
Open worldNo

Input

FieldTypeRequiredDescription
includePastbooleanNoTrue to also list promos whose aftermath has ended. Default false: only promos running now, in their aftermath, or coming up.

Output

FieldTypeRequiredDescription
asOfstringYesThe brand's own calendar day the timings are judged on, in its ad account's time zone, YYYY-MM-DD.
includePastbooleanYes
windowsobject[]Yes

REST equivalent

MCP only. No REST operation does the same thing.

On this page