Skip to main content
GET
Campanhas de todos os produtos

Escopo

Com metaAds.connected: true, as campanhas do Meta ganham o bloco ads (gasto, impressões, cliques, ROAS, CPA, lucro) e o financial ganha gasto, lucro, ROI e margem. Sem a conexão, a resposta é a mesma, sem esses campos. Veja como a campanha casa com o Meta.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Query Parameters

startDate
string<date>

Primeiro dia do período (AAAA-MM-DD, horário de Brasília). Sem ele, o período termina em endDate e tem 30 dias.

endDate
string<date>

Último dia do período, incluído (AAAA-MM-DD). Sem ele, hoje. O período vai até 12 meses (366 dias).

platform
enum<string>

Só as vendas de uma plataforma, pela utm_source (ou pelo id de clique do anúncio). whatsapp, email e organico são origens marcadas à mão; outras, o resto que não é rede de anúncio; sem_utm, venda sem origem.

Available options:
meta,
google,
tiktok,
kwai,
whatsapp,
email,
organico,
outras,
sem_utm
adAccount
string

Só o gasto de uma conta de anúncio do Meta (act_..., de metaAds.adAccounts). Conta que não é da sua conexão é ignorada.

Response

period
object
platform
string | null
hasVisits
boolean

false com filtro de plataforma: aí as campanhas saem sem visits.

summary
object
platforms
object[]
campaigns
object[]

Até 20 campanhas, e o resto em outros.

placements
object[]

Posicionamentos (utm_term), os 10 que mais venderam.

financial
object | null

O resumo financeiro do período. Com o Meta conectado entram o gasto e o que depende dele; sem a conexão, esses campos vêm null. null inteiro quando o cálculo passa do tempo.

metaAds
object

Indicador da conexão com o Meta Ads. Vem em toda resposta de Analytics, com ou sem conexão.