POST /v1/analytics/marketing/overview/search
POST
/v1/analytics/marketing/overview/search
const url = 'https://seu-endereco-da-api/v1/analytics/marketing/overview/search';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"range":{"preset":"today","since":"example","until":"example"},"compare":true,"adAccountId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","filter":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/analytics/marketing/overview/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "range": { "preset": "today", "since": "example", "until": "example" }, "compare": true, "adAccountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "filter": {} }'Indicadores, funil e destaques do relatório de marketing. O período é resolvido em America/Sao_Paulo; com compare, previous traz as mesmas métricas do período imediatamente anterior, de mesmo tamanho.
Permissão que a Chave de acesso precisa: Relatórios de marketing (analytics:marketing).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
range
required
object
preset
required
string
since
string
until
string
compare
boolean
adAccountId
string format: uuid
filter
object
key
additional properties
any
Responses
Seção intitulada “Responses”Media typeapplication/json
object
range
required
object
firstDay
required
string format: date
lastDay
required
string format: date
previousRange
required
object
firstDay
required
string format: date
lastDay
required
string format: date
timezone
required
string
connected
required
boolean
adsAvailable
required
boolean
currency
required
string
metrics
required
object
key
additional properties
number
previous
required
object
key
additional properties
number
topLossReason
required
string
best
required
As 3 campanhas com maior ROI entre as que venderam
Array<object>
object
accountId
required
string
id
required
string
name
required
string
objective
required
string
status
required
string
canManage
required
A conta de anúncios aceita escrita: ads_management com token vivo
boolean
currency
required
string
spend
required
Centavos da moeda da conta
number
revenue
required
number
sales
required
number
leads
required
number
roi
required
(receita - gasto) / gasto, em %
number
roas
required
number
wasting
required
As 3 que mais gastaram sem vender; campanhas de reconhecimento ficam de fora
Array<object>
object
accountId
required
string
id
required
string
name
required
string
objective
required
string
status
required
string
canManage
required
A conta de anúncios aceita escrita: ads_management com token vivo
boolean
currency
required
string
spend
required
Centavos da moeda da conta
number
revenue
required
number
sales
required
number
leads
required
number
roi
required
(receita - gasto) / gasto, em %
number
roas
required
number
Example
{ "best": [ { "status": "ACTIVE" } ], "wasting": [ { "status": "ACTIVE" } ]}