Pular para o conteúdo

Listar métricas de mídia por anúncio e dia

GET
/ad-metrics
 
curl --request GET \
  --url 'https://dattacrm.com.br/api/v1/ad-metrics?since=2026-11-01&until=2026-11-07&platform=meta&limit=100' \
  --header 'Authorization: Bearer <token>'

Lista as métricas de anúncios gravadas na conta (coletadas pelo CRM ou enviadas por POST /ad-metrics), uma linha por plataforma, dia e anúncio, na ordem de dia, plataforma e anúncio. since e until (AAAA-MM-DD, os dois inclusive) são obrigatórios e podem distar no máximo 93 dias. platform e campaignId filtram. De 1 a 500 registros por página (padrão 100): use nextCursor no parâmetro cursor para a página seguinte; quando vier nulo, acabou. A leitura exige um plano com painel de anúncios (Pro, Max ou Agência); nos outros a chamada é recusada com plan_required (403) e os dados ficam guardados.

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Query Parameters

Seção intitulada “Query Parameters ”
since
required

Primeiro dia (inclusive), no formato AAAA-MM-DD.

string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
Example 
2026-11-01

Primeiro dia (inclusive), no formato AAAA-MM-DD.

until
required

Último dia (inclusive), no formato AAAA-MM-DD. No máximo 93 dias depois de since.

string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
Example 
2026-11-07

Último dia (inclusive), no formato AAAA-MM-DD. No máximo 93 dias depois de since.

platform

Só esta plataforma: meta, google, tiktok ou linkedin.

string
Allowed values: meta google tiktok linkedin

Só esta plataforma: meta, google, tiktok ou linkedin.

campaignId

Só os anúncios desta campanha (identificador da campanha na plataforma).

string
>= 1 characters <= 200 characters

Só os anúncios desta campanha (identificador da campanha na plataforma).

cursor

Cursor da página anterior (nextCursor).

string

Cursor da página anterior (nextCursor).

limit

Registros por página (1 a 500, padrão 100).

integer
default: 100 >= 1 <= 500

Registros por página (1 a 500, padrão 100).

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Sucesso.

Media type application/json
object
data
required

Registros da página, por dia, plataforma e anúncio.

Array<object>

Métricas de um anúncio em um dia, como estão gravadas.

object
date
required

Dia da métrica na plataforma (data civil na conta de anúncios), no formato AAAA-MM-DD.

string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
adId
required

Identificador do anúncio na plataforma (no Google PMax, o id do grupo de recursos). Com platform e date, é a chave do registro.

string
>= 1 characters <= 200 characters
accountId
Any of:
string
<= 200 characters
accountName
Any of:
string
<= 500 characters
campaignId
Any of:
string
<= 200 characters
campaignName
Any of:
string
<= 500 characters
adsetId
Any of:
string
<= 200 characters
adsetName
Any of:
string
<= 500 characters
adName
Any of:
string
<= 500 characters
adStatus
Any of:
string
<= 100 characters
adUrl
Any of:
string
<= 2000 characters
adThumbnail
Any of:
string
<= 2000 characters
spend

Investimento do dia, na moeda da conta de anúncios. Nulo quando não informado.

number | null
impressions
Any of:
integer
>= -9007199254740991 <= 9007199254740991
reach
Any of:
integer
>= -9007199254740991 <= 9007199254740991
clicks
Any of:
integer
>= -9007199254740991 <= 9007199254740991
pageViews
Any of:
integer
>= -9007199254740991 <= 9007199254740991
platformLeads
Any of:
integer
>= -9007199254740991 <= 9007199254740991
checkouts
Any of:
integer
>= -9007199254740991 <= 9007199254740991
platformPurchases
Any of:
integer
>= -9007199254740991 <= 9007199254740991
platformRevenue

Receita das compras contadas pela plataforma no dia. Nulo quando não informado.

number | null
messagingStarted
Any of:
integer
>= -9007199254740991 <= 9007199254740991
currency
Any of:
string
/^[A-Z]{3}$/
extra

Qualquer outro dado do registro (vídeo, engajamento, LinkedIn etc.), como objeto JSON. Quando enviado, substitui o extra anterior inteiro; quando ausente, o anterior fica.

object
key
additional properties
platform
required

Plataforma do registro.

string
Allowed values: meta google tiktok linkedin
updatedAt
required

Quando o registro foi gravado pela última vez.

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
nextCursor
required

Cursor da próxima página; nulo na última página.

string | null
Example 
{
  "data": [
    {
      "date": "2026-11-03",
      "platform": "meta",
      "updatedAt": "2026-10-19T12:00:00.000Z"
    }
  ]
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

X-RateLimit-Limit
integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining
integer

Requisições restantes na janela atual.

X-RateLimit-Reset
integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

400

Seção intitulada “400 ”

Dados inválidos na requisição (validation_error): since ou until fora do formato AAAA-MM-DD ou ausentes, since depois de until, mais de 93 dias entre eles, platform desconhecida, limit fora de 1 a 500 ou cursor inválido.

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

401

Seção intitulada “401 ”

Chave ausente, inválida (invalid_api_key), vencida (api_key_expired) ou revogada (api_key_revoked).

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

429

Seção intitulada “429 ”

Limite de requisições atingido (rate_limited). Aguarde Retry-After segundos.

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

X-RateLimit-Limit
integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining
integer

Requisições restantes na janela atual.

X-RateLimit-Reset
integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

Retry-After
integer

Segundos até poder tentar de novo.

500

Seção intitulada “500 ”

Erro interno (internal_error). Informe o requestId ao suporte.

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.