Pular para o conteúdo

POST /v1/analytics/marketing/overview/search

POST
/v1/analytics/marketing/overview/search
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).

Media typeapplication/json
object
range
required
object
preset
required
string
Allowed values: today yesterday today_and_yesterday last_7d last_14d last_28d last_30d this_week last_week this_month last_month maximum custom
since
string
until
string
compare
boolean
adAccountId
string format: uuid
filter
object
key
additional properties
any
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
nullable
metrics
required
object
key
additional properties
number
nullable
previous
required
object
key
additional properties
number
nullable
topLossReason
required
string
nullable
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
nullable
status
required
string
Allowed values: ACTIVE PAUSED
canManage
required

A conta de anúncios aceita escrita: ads_management com token vivo

boolean
currency
required
string
nullable
spend
required

Centavos da moeda da conta

number
revenue
required
number
sales
required
number
leads
required
number
roi
required

(receita - gasto) / gasto, em %

number
nullable
roas
required
number
nullable
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
nullable
status
required
string
Allowed values: ACTIVE PAUSED
canManage
required

A conta de anúncios aceita escrita: ads_management com token vivo

boolean
currency
required
string
nullable
spend
required

Centavos da moeda da conta

number
revenue
required
number
sales
required
number
leads
required
number
roi
required

(receita - gasto) / gasto, em %

number
nullable
roas
required
number
nullable

Example

{
"best": [
{
"status": "ACTIVE"
}
],
"wasting": [
{
"status": "ACTIVE"
}
]
}