VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Visão geral

Como medir o WhatsApp da loja: mensagens, custos da Meta, funil, anúncios, campanhas, orçamento e catálogo.

O WhatsApp só vale a pena se der para medir. Esta seção reúne as rotas de resultados: quantas mensagens saem e são lidas, quanto a Meta cobra, quantos cliques viram pedidos, qual anúncio compensa, como vão as campanhas, quanto da verba mensal foi usado e se o catálogo está em dia.

Pontos-chave
  • Quase tudo é da loja inteira. A única leitura filtrada pelas contas do seller é o Uso mensal.
  • Valores em dinheiro são inteiros em centavos, exceto o uso mensal, que usa milionésimos de real (*_micros, 1 real = 1000000).
  • overview, costs e funnel respondem 404 disabled quando a loja desligou enable_analytics.
  • A janela days vale 30 por padrão e não tem teto.
  • Custos são estimativas de uma tabela de tarifas, não a fatura da Meta.

Como funciona

  1. Veja o panorama
    Visão geral mostra volume e taxa de leitura; o funil mostra a conversão em pedidos.
  2. Controle o custo
    Uso e custos separa mensagens de serviço, templates e pontos de entrada gratuitos, e estima o que passa da franquia.
  3. Defina um teto
    Em Orçamento, fixe o limite mensal e, se quiser, pare as campanhas ao atingi-lo.
  4. Acompanhe as campanhas e o catálogo
    Campanhas e Catálogo da Meta mostram o que foi enviado e o que está sincronizado.

Conceitos-chave

Categorias de mensagem da Meta

CategoriaO que éCobrança
Serviço (SERVICE)Resposta a um cliente dentro da janela de 24 horasGratuita até a franquia mensal; depois cobrada
Utilidade (UTILITY)Template transacional (pedido enviado)Por mensagem
Marketing (MARKETING)Template promocionalPor mensagem
Autenticação (AUTHENTICATION)Template de códigoPor mensagem
Ponto de entrada gratuitoRespostas nas 72 horas após um anúncio que leva ao WhatsAppGratuita

Coexistência e economia

Quando uma pessoa responde pelo aplicativo WhatsApp Business (origem E), a mensagem não passa pela API. Em Custos o campo savings estima quanto isso economiza.

Tempo

Os relatórios mensais usam o fuso America/Sao_Paulo. Datas dos demais campos em RFC 3339 (UTC).

Endpoints

MétodoCaminhoPara que serve
GET/api/v1/vendor/whatsapp-confluence/analytics/overviewIndicadores, série diária e origem das mensagens. Visão geral, funil e anúncios
GET/api/v1/vendor/whatsapp-confluence/analytics/funnelDo clique no link ao pedido, por canal. Visão geral, funil e anúncios
GET/api/v1/vendor/whatsapp-confluence/analytics/roasRetorno por anúncio que leva ao WhatsApp. Visão geral, funil e anúncios
GET/api/v1/vendor/whatsapp-confluence/analytics/costsCusto diário, projeção e economia da coexistência. Uso e custos
GET/api/v1/vendor/whatsapp-confluence/analytics/usageMensagens enviadas no mês, por categoria e conta. Uso e custos
GET/api/v1/vendor/whatsapp-confluence/campaignsLista as campanhas da loja. Campanhas
GET/api/v1/vendor/whatsapp-confluence/analytics/campaignsAs 20 campanhas com mais envios e o custo estimado. Campanhas
GET/api/v1/vendor/whatsapp-confluence/budgetRetorna o orçamento e o gasto do mês. Orçamento mensal
PUT/api/v1/vendor/whatsapp-confluence/budgetDefine o orçamento mensal. Orçamento mensal
GET/api/v1/vendor/whatsapp-confluence/catalog/statusResume a sincronização do catálogo. Catálogo da Meta
GET/api/v1/vendor/whatsapp-confluence/catalog/itemsLista os itens e o estado de sincronização. Catálogo da Meta

Erros comuns

  • Tratar 404 disabled como erro de rota. É o recurso de analytics desligado na loja; ligue enable_analytics nos ajustes.
  • Passar month=2026-9. O formato exige dois dígitos (2026-09); caso contrário vem 400.
  • Somar cost_cents e estimate_micros como se fossem a mesma unidade. Um é centavos, o outro milionésimos de real.
  • Esperar que o seller veja só os próprios números. Exceto o uso mensal, o resto cobre a loja.
  • Gravar o orçamento sem reenviar o limite. O PUT substitui tudo: o limite omitido é removido.
  • Achar que o teto rígido bloqueia o atendimento. Ele só pausa campanhas.

Próximos passos

Atendimento
Responder, assumir e cobrar dentro da conversa.
Configuração
Ajustes que alimentam estes relatórios.
Visão geral
Comece pelos indicadores.
Anterior
Sugestões de nome e descrição
Próxima
Visão geral, funil e anúncios
Nesta página
  • Como funciona
  • Conceitos-chave
  • Categorias de mensagem da Meta
  • Coexistência e economia
  • Tempo
  • Endpoints
  • Erros comuns
  • Próximos passos