API atual/Referência completa/WhatsApp: resultados e orçamento

Desempenho das campanhas

Lista as 20 campanhas de mensagens em massa com mais envios, com o resultado de cada uma e o custo estimado.

Uma campanha envia um template aprovado pela Meta a uma lista de clientes (a audiência). Esta rota é o placar: quantos destinatários, quantas mensagens saíram, foram entregues, lidas ou falharam, e quanto isso deve custar. Para criar, agendar ou cancelar campanhas, veja a seção campanhas.

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

As 20 campanhas com mais envios e o custo estimado

Cabeçalhos

Authorizationstringobrigatório

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

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/analytics/campaigns" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Desempenho

json

{
  "campaigns": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Ofertas de outubro",
      "template_name": "oferta_semana",
      "template_category": "MARKETING",
      "total": 480,
      "sent": 470,
      "delivered": 455,
      "read": 310,
      "failed": 10,
      "estimated_cost_cents": 17280
    }
  ]
}

Campos da resposta

campaignsarray

Até 20 campanhas, as com mais enviadas primeiro (empate: a mais recente). Lista vazia se a loja nunca fez campanha.

iduuid

Id da campanha.

namestring

Nome interno.

template_namestring

Template enviado.

template_categorystring

Categoria do template na Meta (MARKETING, UTILITY, AUTHENTICATION). UTILITY quando a plataforma não conhece o template.

totalinteger

Destinatários da audiência.

sentinteger

Mensagens enviadas.

deliveredinteger

Entregues.

readinteger

Lidas.

failedinteger

Falhas.

estimated_cost_centsinteger

total vezes a tarifa atual da categoria, em centavos.

Erros

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

Veja também