VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: resultados e orçamento

Visão geral, funil e anúncios

Indicadores de mensagens, funil de vendas do WhatsApp e retorno sobre o investimento em anúncios, para a loja inteira.

Três leituras para responder "o WhatsApp está dando resultado?": o volume de mensagens e a taxa de leitura, o funil que vai do clique no link até o pedido, e o ROAS (retorno sobre o investimento em anúncios) dos anúncios que levam ao WhatsApp. Todas aceitam uma janela em dias (days, 30 por padrão) e cobrem a loja inteira.

Visão geral

GET/api/v1/admin/whatsapp-confluence/analytics/overviewAdmin

Indicadores, série diária e origem das mensagens

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um administrador da loja. Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30
Janela em dias, contada até agora. Ausente ou que não é número vale 30. Não há teto. Zero ou negativo zera os contadores e deixa series e by_origin vazios; budget continua.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/whatsapp-confluence/analytics/overview?days=7" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Visão geral
json
{
  "kpis": {
    "sent": 128,
    "received": 211,
    "delivered_rate": 0.97,
    "read_rate": 0.82,
    "threads_active": 45,
    "handoffs": 9
  },
  "series": [
    {
      "day": "2026-10-09",
      "sent": 20,
      "received": 31,
      "read": 16
    },
    {
      "day": "2026-10-10",
      "sent": 18,
      "received": 29,
      "read": 15
    }
  ],
  "by_origin": [
    {
      "origin": "B",
      "count": 90
    },
    {
      "origin": "A",
      "count": 30
    },
    {
      "origin": "E",
      "count": 8
    }
  ],
  "budget": {
    "spent_cents": 4200,
    "monthly_cents": 50000,
    "pct": 8.4
  }
}

Campos da resposta

kpisobject

Indicadores da janela.

sentinteger
Mensagens enviadas pela loja.
receivedinteger
Mensagens recebidas de clientes.
delivered_ratenumber
Fração das enviadas já entregues ou lidas, de 0 a 1. Vale 0 se nada foi enviado.
read_ratenumber
Fração das enviadas já lidas, de 0 a 1.
threads_activeinteger
Conversas com mensagem na janela.
handoffsinteger
Conversas que passaram do assistente para uma pessoa.
seriesarray
Um item por dia com atividade: day (YYYY-MM-DD), sent, received, read. Dias sem mensagem não aparecem.
by_originarray
Mensagens enviadas por origem (origin, veja a tabela de origens) e count, da maior para a menor.
budgetobject
Gasto do mês: spent_cents sempre; monthly_cents e pct (percentual gasto) só aparecem se há orçamento mensal maior que 0. Veja Orçamento mensal.

Erros

StatusQuandoCorpo de exemplo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um administrador.{"error":"insufficient permissions"}
404O recurso de analytics está desligado na loja (enable_analytics).{"error":"disabled"}
500Falha interna ao ler ou gravar.{"error":"..."}
Janela vazia não é erro

Sem mensagens na janela, a resposta é 200 com contadores em 0, series e by_origin vazios. Ao testar, aumente days antes de concluir que a integração falhou.

Funil de vendas

O funil conta quatro eventos registrados quando o cliente usa os links enviados no WhatsApp: clique no link da loja, item no carrinho, checkout iniciado e pedido concluído. Um evento não depende do anterior, então os números podem não formar uma escada perfeita.

GET/api/v1/admin/whatsapp-confluence/analytics/funnelAdmin

Do clique no link ao pedido, por canal

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um administrador da loja. Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30
Janela em dias, contada até agora. Ausente ou que não é número vale 30. Não há teto. Zero ou negativo devolve tudo vazio.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/whatsapp-confluence/analytics/funnel?days=30" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Funil
json
{
  "link_clicks": 46,
  "cart_adds": 12,
  "checkouts": 5,
  "orders": 3,
  "revenue_cents": 89700,
  "by_ref": [
    {
      "ref": "campanha-outubro",
      "label": "Campanha de outubro",
      "orders": 2,
      "revenue_cents": 59800
    },
    {
      "ref": "",
      "label": "",
      "orders": 1,
      "revenue_cents": 29900
    }
  ]
}

Campos da resposta

link_clicksinteger
Cliques em links da loja enviados pelo WhatsApp.
cart_addsinteger
Itens adicionados ao carrinho.
checkoutsinteger
Checkouts iniciados.
ordersinteger
Pedidos concluídos.
revenue_centsinteger
Receita dos pedidos, em centavos.
by_refarray
Pedidos por canal de origem (até 20 linhas, maior receita primeiro, só canais com pedido): ref (vazio = acesso direto, sem link rotulado), label (nome amigável do link, vazio se não há), orders, revenue_cents.

Erros

StatusQuandoCorpo de exemplo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um administrador.{"error":"insufficient permissions"}
404O recurso de analytics está desligado na loja (enable_analytics).{"error":"disabled"}
500Falha interna ao ler ou gravar.{"error":"..."}
Rotule os links de entrada

O canal (ref) vem do link usado na campanha ou na divulgação. Sem rótulo, o ref aparece cru; dê nomes aos links de entrada para a leitura ficar clara.

ROAS dos anúncios

ROAS é a receita dividida pelo que foi gasto no anúncio: 4,48 significa R$ 4,48 de venda para cada R$ 1,00 investido. Só entram anúncios "clique para WhatsApp" cujo desempenho a plataforma já recebeu da Meta.

GET/api/v1/admin/whatsapp-confluence/analytics/roasAdmin

Retorno por anúncio que leva ao WhatsApp

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um administrador da loja. Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30
Janela em dias, contada até agora. Ausente ou que não é número vale 30. Não há teto. Zero ou negativo vale 30.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/whatsapp-confluence/analytics/roas?days=30" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Anúncios
json
{
  "ads": [
    {
      "ad_id": "120210987654321",
      "ad_name": "Promo de inverno",
      "spend_cents": 25000,
      "conversations": 64,
      "orders": 7,
      "revenue_cents": 112000,
      "roas": 4.48
    }
  ]
}

Campos da resposta

adsarray

Um item por anúncio, da maior receita para a menor. Lista vazia se a loja não tem dados de anúncios.

ad_idstring
Id do anúncio na Meta.
ad_namestring
Nome do anúncio.
spend_centsinteger
Investimento em centavos.
conversationsinteger
Conversas iniciadas pelo anúncio.
ordersinteger
Pedidos atribuídos.
revenue_centsinteger
Receita atribuída, em centavos.
roasnumber
Receita dividida pelo investimento. Vale 0 se não houve investimento.

Erros

StatusQuandoCorpo de exemplo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um administrador.{"error":"insufficient permissions"}
500Falha interna ao ler ou gravar.{"error":"..."}
Sem trava de recurso

Diferente de overview, costs e funnel, esta rota não responde 404 disabled quando enable_analytics está desligado.

Veja também

  • Custos e uso mensal
  • Desempenho das campanhas
  • Visão geral da seção
Anterior
Resultados e orçamento
Próxima
Custos e uso mensal
Nesta página
  • Visão geral
  • Exemplo de requisição
  • Resposta
  • Erros
  • Funil de vendas
  • Exemplo de requisição
  • Resposta
  • Erros
  • ROAS dos anúncios
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também