Skip to main content

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).

Required scope: advertising:read

Grant 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_rate x days_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_missing is 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​

OK

Response Headers
    Content-Type