v1Resources/Paid Boosts/getGet a boost
Get a boost
Returns one boost by its id: status, budget, spend, the post and the control that applies.
get
boosts:read/api/v1/boosts/{adRunId}Query parameters
adRunIdstringrequired
The boost's id, from the list or the create response.
Response
dataobjectoptional
adRunIdstringoptional
The boost's id.
adCampaignIdstringoptional
The ad campaign it belongs to.
postIdstringoptional
The post it promotes.
platformstringoptional
The network it runs on.
statusstringoptional
init, submitted, active, paused, stopped, cancelled, completed, rejected, error or awaiting_publish.
deferredbooleanoptional
True when it is waiting for its post to publish; nothing has been spent.
controlstringoptional
stop for a live boost, cancel for a deferred one, null once it is over.
dailyBudgetintegeroptional
The daily budget, in minor currency units.
durationDaysintegeroptional
How many days it runs.
startAtstringoptional
When spend starts, as a date-time.
endAtstringoptional
When it ends, as a date-time.
createdAtstringoptional
When the boost was created.
stoppedAtstringoptional
When it was stopped, if it was.
spendnumberoptional
What has been spent so far.
impressionsintegeroptional
Impressions so far.
clicksintegeroptional
Clicks so far.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/boosts/{adRunId}
Your API key
adRunId *
{}