API atual/Referência completa/WhatsApp: resultados

Visão geral, funil e anúncios

Indicadores de mensagens, funil de vendas do WhatsApp e retorno sobre investimento em anúncios.

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 dos anúncios que levam ao WhatsApp. Todas aceitam uma janela em dias (days, 30 por padrão) e valem para a loja inteira.

Visão geral

GET/api/v1/vendor/whatsapp-confluence/analytics/overviewSeller

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

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30

Janela em dias, contada até agora. Valor ausente ou que não é número vale 30.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/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.

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.

by_originarray

Enviadas por origem (origin: B assistente, A API ou atendente, E aplicativo, H histórico) e count, da maior para a menor.

budgetobject

Gasto do mês: spent_cents sempre; monthly_cents e pct (percentual gasto) só se há orçamento mensal definido e maior que 0.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	O recurso de analytics está desligado na loja (`enable_analytics`).	`{"error":"disabled"}`
500	Falha interna ao calcular.	`{"error":"..."}`

Funil de vendas

GET/api/v1/vendor/whatsapp-confluence/analytics/funnelSeller

Do clique no link ao pedido, por canal

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30

Janela em dias, contada até agora. Valor ausente ou que não é número vale 30.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/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), label (nome amigável do link, vazio se não há), orders, revenue_cents.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	O recurso de analytics está desligado na loja (`enable_analytics`).	`{"error":"disabled"}`
500	Falha interna ao calcular.	`{"error":"..."}`

ROAS dos anúncios

GET/api/v1/vendor/whatsapp-confluence/analytics/roasSeller

Retorno por anúncio que leva ao WhatsApp

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30

Janela em dias, contada até agora. Valor ausente ou que não é número vale 30.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/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 anuncia.

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

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
500	Falha interna ao calcular.	`{"error":"..."}`

Veja também

API atual/Referência completa/WhatsApp: resultados

Visão geral, funil e anúncios

Indicadores de mensagens, funil de vendas do WhatsApp e retorno sobre investimento em anúncios.

Visão geral

GET/api/v1/vendor/whatsapp-confluence/analytics/overviewSeller

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

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30

Janela em dias, contada até agora. Valor ausente ou que não é número vale 30.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/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.

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.

by_originarray

Enviadas por origem (origin: B assistente, A API ou atendente, E aplicativo, H histórico) e count, da maior para a menor.

budgetobject

Gasto do mês: spent_cents sempre; monthly_cents e pct (percentual gasto) só se há orçamento mensal definido e maior que 0.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	O recurso de analytics está desligado na loja (`enable_analytics`).	`{"error":"disabled"}`
500	Falha interna ao calcular.	`{"error":"..."}`

Funil de vendas

GET/api/v1/vendor/whatsapp-confluence/analytics/funnelSeller

Do clique no link ao pedido, por canal

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30

Janela em dias, contada até agora. Valor ausente ou que não é número vale 30.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/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

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	O recurso de analytics está desligado na loja (`enable_analytics`).	`{"error":"disabled"}`
500	Falha interna ao calcular.	`{"error":"..."}`

ROAS dos anúncios

GET/api/v1/vendor/whatsapp-confluence/analytics/roasSeller

Retorno por anúncio que leva ao WhatsApp

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de consulta

daysintegerpadrão: 30

Janela em dias, contada até agora. Valor ausente ou que não é número vale 30.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/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 anuncia.

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

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
500	Falha interna ao calcular.	`{"error":"..."}`