Metrics

Métricas do X Ads pela API

Seu cliente conecta a conta do X Ads e seu produto consulta 14 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "tads:likes",
      "component": "number_v1",
      "metrics": [
        "likes"
      ],
      "dimensions": [
        "engagement"
      ]
    }
  ]
}
Exemplo: "Curtidas" em outubro, comparado a setembro.

Mais exemplos de chamadas no X Ads

O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).

Tabela

Campanhas em destaque

Campaigns that had the greatest impact on your audience during the period analyzed.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "tads:featured_campaigns",
      "component": "datatable_v1",
      "metrics": [
        "likes",
        "replies",
        "retweets",
        "billed_charge_local_micro",
        "total_clicks",
        "engagements"
      ],
      "dimensions": [
        "engagement"
      ]
    }
  ]
}

Número

Impressões

Número de usuários que visualizam uma campanha. Contabilizamos apenas as impressões no conteúdo promovido. Portanto, as impressões geradas de maneira orgânica não são contabilizadas.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "tads:impressions",
      "component": "number_v1",
      "metrics": [
        "impressions"
      ],
      "dimensions": [
        "engagement"
      ]
    }
  ]
}

Números

13 métricas

  • Curtidas

    Número total de curtidas que seus anúncios receberam.

    tads:likes
  • Impressões

    Número de usuários que visualizam uma campanha. Contabilizamos apenas as impressões no conteúdo promovido. Portanto, as impressões geradas de maneira orgânica não são contabilizadas.

    tads:impressions
  • Engajamento Total

    O engajamento indica o número de interações do usuário com sua campanha. Nos engajamentos são contabilizados todos os cliques no Tweet, incluindo Retweets, respostas, curtidas, votos em enquetes e cliques em hashtags.

    tads:engagements
  • Retweets

    Número total de retweets que seus anúncios receberam.

    tads:retweets
  • Seguidores perdidos

    Número de pessoas que deixaram de seguir sua conta a partir de um anúncio.

    tads:unfollows
  • Cliques

    Total de cliques em links, hashtags, card do site e outros detalhes do Tweet em seu anúncio, combinado com curtidas e cliques no perfil.

    tads:clicks
  • Respostas

    Número total de respostas que seus anúncios receberam. Respostas são um Tweet em resposta a outro Tweet. Ela geralmente é publicada quando você clica no botão Responder ao lado do Tweet em sua timeline. Uma resposta sempre começa com @nomedeusuario.

    tads:replies
  • Total de Cliques

    Número total de cliques em seus anúncios. Inclui os cliques na URL (links encurtados ou normais), foto de perfil, nome de tela, nome de usuário, detalhes, hashtags, curtidas e cliques no botão aplicativo (instalação ou abertura de um app).

    tads:total_clicks
  • Cliques no aplicativo

    Número de cliques no botão aplicativo (cliques para instalação ou abertura de um app).

    tads:app_clicks
  • CPE

    Custo por engajamento (CPE) representa em média quanto cada engajamento custou para você. Ele é calculado dividindo o gasto total da campanha pelo número de engajamentos (como curtidas, Retweets e respostas).

    tads:cpe
  • CPC

    O Custo por Clique (CPC) representa em média quanto cada clique custa para você. Ele é calculado dividindo o gasto total da campanha pelo número total de cliques.

    tads:cpc
  • Valor Investido

    O valor total estimado que você gastou em sua campanha.

    tads:spend
  • Taxa de engajamento total

    A taxa de Engajamento representa o total de interações em seu anúncio, levando em consideração as impressões delas. Ela é calculada dividindo o número total de interações (curtidas, retweets, respostas, cliques e seguidores ganhos) com o volume de impressões.

    tads:engagement_rate

Tabelas

1 métrica

  • Campanhas em destaque

    Campaigns that had the greatest impact on your audience during the period analyzed.

    tads:featured_campaigns

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.