Skip to main content
GET
Retrieve budgets and forecasts (Ad Spend Budget, Sales Budget, Sales Forecast)

Authorizations

x-api-key
string
header
required

Query Parameters

channelId
string
required

Channel (store) ID.

merchantId
string
required

Merchant ID that owns the channel. URL-encode values containing spaces or '@'.

fromDate
integer
required

Start of date range as unix epoch seconds.

toDate
integer
required

End of date range as unix epoch seconds.

timezone
string
required

IANA timezone string, for example Australia/Sydney.

interval
enum<string>
default:day

Time bucket size for the data breakdown. day returns one entry per day, week per week, month per month. Defaults to day.

Available options:
day,
week,
month

Response

Successful operation

data
object[]

Chronologically ordered, with one entry per interval bucket.

totals
object

Summed roll-up across the whole range.

Example:
meta
object