LeadGo
Criar conta
Páginas da documentação

Desenvolvedores · Referência · v1.2.0

Métricas e relatórios

Resultados da conta, de cada campanha e de cada anúncio, lidos da Meta (atualizam a cada 15–60 min).

https://leadgo.com.br/api/v1 Baixar arquivo para IA OpenAPI 3.1 Criar token
GET /campaigns/{id}/metrics reports:read

Métricas da campanha

Resumo, série diária e quebras (idade, gênero, plataforma) do período, no fuso da conta, mais o resultado de cada conjunto (ad_sets) e de cada anúncio (ads), para comparar criativos. Valores de dinheiro na moeda da conta, em unidades (312.5 = R$ 312,50). results segue o objetivo (compras, leads do formulário, conversas do WhatsApp...). Até 90 dias por consulta; sem datas, os últimos 7 dias. Cache de 10 minutos.

Parâmetros

from string Data inicial (AAAA-MM-DD).
to string Data final (AAAA-MM-DD), inclusive.

Exemplo

cURL 
curl -X GET "https://leadgo.com.br/api/v1/campaigns/{id}/metrics?from=2026-10-01&to=2026-10-27" \
  -H "Authorization: Bearer $LEADGO_TOKEN" \
  -H "Accept: application/json"

Resposta 200

HTTP 200 
{
    "data": {
        "campaign_id": "01jby0q4c8m2d6t9v3k7w5r1xa",
        "from": "2026-10-01",
        "to": "2026-10-27",
        "currency": "BRL",
        "result_goal": "conversions",
        "summary": {
            "spend": 312.5,
            "impressions": 48000,
            "reach": 21000,
            "clicks": 960,
            "results": 24,
            "purchase_value": 1890,
            "ctr": 2,
            "cpc": 0.3255,
            "cpm": 6.5104,
            "cost_per_result": 13.0208,
            "roas": 6.048
        },
        "daily": [
            {
                "date": "2026-10-27",
                "spend": 12.3,
                "impressions": 1900,
                "reach": 1500,
                "clicks": 41,
                "results": 1,
                "purchase_value": 89.9,
                "ctr": 2.1579,
                "cpc": 0.3,
                "cpm": 6.4737,
                "cost_per_result": 12.3,
                "roas": 7.309
            }
        ],
        "breakdowns": {
            "age": [
                {
                    "age": "25-34",
                    "spend": 200
                }
            ]
        },
        "backfill_pending": false,
        "ad_sets": [
            {
                "id": 88,
                "name": "Mulheres 25-45 SP",
                "spend": 312.5,
                "impressions": 48000,
                "reach": 21000,
                "clicks": 960,
                "results": 24,
                "purchase_value": 1890,
                "ctr": 2,
                "cpc": 0.3255,
                "cpm": 6.5104,
                "cost_per_result": 13.0208,
                "roas": 6.048
            }
        ],
        "ads": [
            {
                "id": 140,
                "ad_set_id": 88,
                "name": "Promoção de outubro - Anúncio 1",
                "spend": 312.5,
                "impressions": 48000,
                "reach": 21000,
                "clicks": 960,
                "results": 24,
                "purchase_value": 1890,
                "ctr": 2,
                "cpc": 0.3255,
                "cpm": 6.5104,
                "cost_per_result": 13.0208,
                "roas": 6.048
            }
        ]
    }
}

Erros: validation_failed, campaign_not_published, platform_quota_exceeded, platform_unavailable

GET /ads/{id}/metrics reports:read

Métricas do anúncio

Resumo, série diária e quebras de um anúncio, no mesmo formato das métricas da campanha (results segue o objetivo dela). Até 90 dias por consulta; sem datas, os últimos 7 dias. Cache de 10 minutos.

Parâmetros

from string Data inicial (AAAA-MM-DD).
to string Data final (AAAA-MM-DD), inclusive.

Exemplo

cURL 
curl -X GET "https://leadgo.com.br/api/v1/ads/{id}/metrics?from=2026-10-01&to=2026-10-27" \
  -H "Authorization: Bearer $LEADGO_TOKEN" \
  -H "Accept: application/json"

Resposta 200

HTTP 200 
{
    "data": {
        "ad_id": 140,
        "campaign_id": "01jby0q4c8m2d6t9v3k7w5r1xa",
        "from": "2026-10-01",
        "to": "2026-10-27",
        "currency": "BRL",
        "result_goal": "conversions",
        "summary": {
            "spend": 312.5,
            "impressions": 48000,
            "reach": 21000,
            "clicks": 960,
            "results": 24,
            "purchase_value": 1890,
            "ctr": 2,
            "cpc": 0.3255,
            "cpm": 6.5104,
            "cost_per_result": 13.0208,
            "roas": 6.048
        },
        "daily": [
            {
                "date": "2026-10-27",
                "spend": 12.3,
                "impressions": 1900,
                "reach": 1500,
                "clicks": 41,
                "results": 1,
                "purchase_value": 89.9,
                "ctr": 2.1579,
                "cpc": 0.3,
                "cpm": 6.4737,
                "cost_per_result": 12.3,
                "roas": 7.309
            }
        ],
        "breakdowns": {
            "publisher_platform": [
                {
                    "publisher_platform": "instagram",
                    "spend": 180
                }
            ]
        },
        "backfill_pending": false
    }
}

Erros: validation_failed, not_found, ad_not_published, platform_quota_exceeded, platform_unavailable

GET /reports/account reports:read

Relatório da conta

Totais e série diária da conta de anúncio inteira (todas as campanhas, inclusive as criadas fora do LeadGo), como na tela Relatórios do painel. results soma os resultados de cada campanha pelo objetivo dela. Até 90 dias por consulta; sem datas, os últimos 7 dias. Cache de 10 minutos.

Parâmetros

from string Data inicial (AAAA-MM-DD).
to string Data final (AAAA-MM-DD), inclusive.

Exemplo

cURL 
curl -X GET "https://leadgo.com.br/api/v1/reports/account?from=2026-10-01&to=2026-10-27" \
  -H "Authorization: Bearer $LEADGO_TOKEN" \
  -H "Accept: application/json"

Resposta 200

HTTP 200 
{
    "data": {
        "period": {
            "from": "2026-10-01",
            "to": "2026-10-27"
        },
        "currency": "BRL",
        "summary": {
            "spend": 312.5,
            "impressions": 48000,
            "reach": 21000,
            "clicks": 960,
            "results": 24,
            "purchase_value": 1890,
            "ctr": 2,
            "cpc": 0.3255,
            "cpm": 6.5104,
            "cost_per_result": 13.0208,
            "roas": 6.048
        },
        "daily": [
            {
                "date": "2026-10-27",
                "spend": 12.3,
                "impressions": 1900,
                "reach": 1500,
                "clicks": 41,
                "results": 1,
                "purchase_value": 89.9,
                "ctr": 2.1579,
                "cpc": 0.3,
                "cpm": 6.4737,
                "cost_per_result": 12.3,
                "roas": 7.309
            }
        ],
        "backfill_pending": false
    }
}

Erros: validation_failed, ad_account_not_linked, platform_quota_exceeded, platform_unavailable

GET /reports/campaigns reports:read

Resultado por campanha

Uma linha por campanha que rodou no período, do maior gasto para o menor, com o id daqui (campaign_id) para cruzar com GET /campaigns. Campanhas criadas fora do LeadGo e ainda não sincronizadas vêm com campaign_id null. Até 90 dias por consulta; sem datas, os últimos 7 dias. Cache de 10 minutos.

Parâmetros

from string Data inicial (AAAA-MM-DD).
to string Data final (AAAA-MM-DD), inclusive.

Exemplo

cURL 
curl -X GET "https://leadgo.com.br/api/v1/reports/campaigns?from=2026-10-01&to=2026-10-27" \
  -H "Authorization: Bearer $LEADGO_TOKEN" \
  -H "Accept: application/json"

Resposta 200

HTTP 200 
{
    "data": {
        "period": {
            "from": "2026-10-01",
            "to": "2026-10-27"
        },
        "currency": "BRL",
        "campaigns": [
            {
                "campaign_id": "01jby0q4c8m2d6t9v3k7w5r1xa",
                "platform_campaign_id": "120212345678900001",
                "name": "Promoção de outubro",
                "status": "active",
                "metrics": {
                    "spend": 312.5,
                    "impressions": 48000,
                    "reach": 21000,
                    "clicks": 960,
                    "results": 24,
                    "purchase_value": 1890,
                    "ctr": 2,
                    "cpc": 0.3255,
                    "cpm": 6.5104,
                    "cost_per_result": 13.0208,
                    "roas": 6.048
                }
            }
        ],
        "backfill_pending": false
    }
}

Erros: validation_failed, ad_account_not_linked, platform_quota_exceeded, platform_unavailable