v1Recursos/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/api/v1/boosts/{adRunId}
boosts:read
Parâmetros de consulta
adRunIdstringobrigatório
The boost's id, from the list or the create response.
Resposta
dataobjectopcional
adRunIdstringopcional
The boost's id.
adCampaignIdstringopcional
The ad campaign it belongs to.
postIdstringopcional
The post it promotes.
platformstringopcional
The network it runs on.
statusstringopcional
init, submitted, active, paused, stopped, cancelled, completed, rejected, error or awaiting_publish.
deferredbooleanopcional
True when it is waiting for its post to publish; nothing has been spent.
controlstringopcional
stop for a live boost, cancel for a deferred one, null once it is over.
dailyBudgetintegeropcional
The daily budget, in minor currency units.
durationDaysintegeropcional
How many days it runs.
startAtstringopcional
When spend starts, as a date-time.
endAtstringopcional
When it ends, as a date-time.
createdAtstringopcional
When the boost was created.
stoppedAtstringopcional
When it was stopped, if it was.
spendnumberopcional
What has been spent so far.
impressionsintegeropcional
Impressions so far.
clicksintegeropcional
Clicks so far.
Erros
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/boosts/{adRunId}
Sua chave de API
adRunId *
{}

Novo na API da Synup?