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

Resultados e orçamento

Como medir o WhatsApp da loja pela API de administração: mensagens, funil, anúncios, custos da Meta, campanhas e orçamento mensal.

O WhatsApp só vale a pena se der para medir. Esta seção reúne as rotas de resultados da API de administração: quantas mensagens saem e são lidas, quanto a Meta cobra, quantos cliques viram pedidos, quais anúncios compensam, como vão as campanhas e quanto da verba mensal já foi gasto. Tudo é da loja inteira, somando todos os números de WhatsApp e todos os sellers.

Pontos-chave
  • Todas as rotas ficam em /api/v1/admin/whatsapp-confluence/... e exigem um token de administrador.
  • Dinheiro é inteiro em centavos (4990 = R$ 49,90), 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. As outras rotas não têm essa trava.
  • 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, funil e anúncios mostra volume, taxa de leitura e a conversão do clique ao pedido.
  2. Controle o custo
    Custos e uso mensal 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 mensal, fixe o limite do mês e, se quiser, pare as campanhas ao atingi-lo.
  4. Compare as campanhas
    Desempenho das campanhas mostra as 20 com mais envios e o custo estimado de cada uma.

Conceitos-chave

Categorias de mensagem da Meta

A Meta cobra por mensagem e o preço depende da categoria.

CategoriaO que éCobrança
SERVICEResposta a um cliente dentro da janela de 24 horasGratuita até a franquia mensal; depois cobrada
UTILITYTemplate transacional (pedido enviado)Por mensagem
MARKETINGTemplate promocionalPor mensagem
AUTHENTICATIONTemplate de códigoPor mensagem
Ponto de entrada gratuitoRespostas nas 72 horas após um anúncio que leva ao WhatsAppGratuita

Origem da mensagem

Cada mensagem tem uma origem de uma letra. Ela aparece em by_origin e nos relatórios de economia.

CódigoQuem enviou
CO cliente (mensagem recebida)
AA API, ou um atendente pela caixa de entrada
BO assistente automático
EO aplicativo WhatsApp Business no celular (eco, a chamada não passa pela API)
HHistórico importado no cadastro do número

Coexistência e economia

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

Fuso e datas

O relatório de uso mensal conta dias e mês em America/Sao_Paulo. Os demais campos de data vêm em RFC 3339 (UTC) ou como YYYY-MM-DD.

Endpoints

MétodoCaminhoPara que serve
GET/api/v1/admin/whatsapp-confluence/analytics/overviewIndicadores, série diária e origem das mensagens. Visão geral, funil e anúncios
GET/api/v1/admin/whatsapp-confluence/analytics/funnelDo clique no link ao pedido, por canal. Visão geral, funil e anúncios
GET/api/v1/admin/whatsapp-confluence/analytics/roasRetorno por anúncio que leva ao WhatsApp. Visão geral, funil e anúncios
GET/api/v1/admin/whatsapp-confluence/analytics/costsCusto diário, projeção e economia da coexistência. Custos e uso mensal
GET/api/v1/admin/whatsapp-confluence/analytics/usageMensagens enviadas no mês, por categoria e conta. Custos e uso mensal
GET/api/v1/admin/whatsapp-confluence/analytics/campaignsAs 20 campanhas com mais envios e o custo estimado. Desempenho das campanhas
GET/api/v1/admin/whatsapp-confluence/budgetLê o orçamento e o gasto do mês. Orçamento mensal
PUT/api/v1/admin/whatsapp-confluence/budgetGrava o orçamento mensal. Orçamento mensal

Erros comuns

  • Tratar 404 disabled como rota inexistente. É o recurso de analytics desligado na loja; ligue enable_analytics nos ajustes.
  • Passar month=2026-9. O uso mensal exige dois dígitos (2026-09); sem eles vem 400.
  • Somar cost_cents e estimate_micros como se fossem a mesma unidade. Um é centavos, o outro milionésimos de real.
  • Esperar uma janela de datas. days conta para trás a partir de agora; não existe from/to.
  • Gravar o orçamento sem reenviar tudo. O PUT substitui o orçamento inteiro: o limite omitido é removido e alert_thresholds omitido vira null.
  • Achar que o teto rígido bloqueia o atendimento. Ele só pausa campanhas.
  • Conciliar a fatura da Meta com estes números. São estimativas por tabela de tarifas.

Próximos passos

Visão geral
Comece pelos indicadores e pelo funil.
Orçamento
Fixe um teto de gasto por mês.
Conexão e configuração
Ligue ou desligue enable_analytics.
Anterior
Produtos e templates
Próxima
Visão geral, funil e anúncios
Nesta página
  • Como funciona
  • Conceitos-chave
  • Categorias de mensagem da Meta
  • Origem da mensagem
  • Coexistência e economia
  • Fuso e datas
  • Endpoints
  • Erros comuns
  • Próximos passos