Pular para o conteúdo
Anúncios

Resumo das campanhas do Meta Ads

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/ads/summary
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposads.read

Gasto, resultados (conversões), custo por resultado e ROAS do período, as 3 campanhas de maior gasto, a tendência contra o período anterior e avisos (anúncio rejeitado ou com problema).

Sempre 200: status diz o resultado de negócio (ok, not_connected, reconnect_needed, sync_pending, sync_failed, no_campaigns, not_found, ambiguous, not_configured, provider_error). Cada chamada lê o Meta na hora.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • periodstringopcional

    Janela de análise: 7d, 14d, 30d ou 90d (padrão 7d).

    • padrão "7d"
    • um de"7d""14d""30d""90d"

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Resumo do período (ou o status de negócio que impede ler os números).

V1AdsSummary

    • status"ok"
      • sempre "ok"
      • destring
      • atestring
    • moedastring
      • gastonumber
      • impressoesnumber
      • cliquesnumber
      • conversoesnumber
      • custoPorConversaonumber | null
      • roasnumber | null
      • itens máx. 3

      Cada item da lista

      • idstring
      • nomestring
        • tamanho máx. 41
      • statusstring
        • um de"ativa""pausada""em_analise""rejeitada""concluida""com_problema"
      • gastonumber
      • conversoesnumber
      • custoPorConversaonumber | null
    • outrasCampanhasnumber
    • campanhasSemAtividadenumber
      • gastoVariacaoPctnumber
      • conversoesVariacaoPctnumber | null
      • custoPorConversaoVariacaoPctnumber | null
      • base"snapshot"
        • sempre "snapshot"
      • itens máx. 2

      Cada item da lista

      • tipostring
        • um de"anuncio_rejeitado""anuncio_com_problema""importacao_falhou"
      • detalhestring
        • tamanho máx. 60
      • quandostring
    • status"not_connected"
      • sempre "not_connected"
    • status"reconnect_needed"
      • sempre "reconnect_needed"
    • motivostring
      • um de"token_revoked""scope_insufficient""caiu"
    • status"sync_pending"
      • sempre "sync_pending"
    • status"sync_failed"
      • sempre "sync_failed"
    • motivostring
      • um de"no_ad_accounts""discovery_failed""sem_resposta""unknown"
    • status"no_campaigns"
      • sempre "no_campaigns"
      • destring
      • atestring
    • status"not_configured"
      • sempre "not_configured"
    • status"provider_error"
      • sempre "provider_error"
    • detalhestring
      • tamanho máx. 200