Get Budget Plan Pacing
GET/api/advertising/budget-plans/:plan/pacing
Returns the plan's pacing: plan vs actual spend vs projected month-end, in the tenant currency, through yesterday (today's spend is not reported yet).
advertising:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
run_rate: mean daily spend over the last (up to) 7 reported days of the month.projected_month_end=spent_to_date+run_ratexdays_remaining.projected_over_under= projected month end - plan amount (positive = over plan).daily_target= remaining amount / days remaining.series: one point per day with the linear plan line (plan), cumulative actual spend (actual, null for future days) and the projection (projected).currency_rate_missingis true when no exchange rate was found for the plan currency, in which case the amount is used unconverted.
Spend is limited to the plan's scope (brand plans count only campaigns advertising that brand's products).
Requires the advertising.view permission.
Available only when the tenant has both the advertising and advertising-manager features enabled; otherwise every route here returns 404.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.