v1Ressources/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}Paramètres de requête
adRunIdstringobligatoire
The boost's id, from the list or the create response.
Réponse
dataobjectfacultatif
adRunIdstringfacultatif
The boost's id.
adCampaignIdstringfacultatif
The ad campaign it belongs to.
postIdstringfacultatif
The post it promotes.
platformstringfacultatif
The network it runs on.
statusstringfacultatif
init, submitted, active, paused, stopped, cancelled, completed, rejected, error or awaiting_publish.
deferredbooleanfacultatif
True when it is waiting for its post to publish; nothing has been spent.
controlstringfacultatif
stop for a live boost, cancel for a deferred one, null once it is over.
dailyBudgetintegerfacultatif
The daily budget, in minor currency units.
durationDaysintegerfacultatif
How many days it runs.
startAtstringfacultatif
When spend starts, as a date-time.
endAtstringfacultatif
When it ends, as a date-time.
createdAtstringfacultatif
When the boost was created.
stoppedAtstringfacultatif
When it was stopped, if it was.
spendnumberfacultatif
What has been spent so far.
impressionsintegerfacultatif
Impressions so far.
clicksintegerfacultatif
Clicks so far.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/boosts/{adRunId}
Votre clé API
adRunId *
{}