Saltar para a documentação
API

Ler o que aconteceu ao correio enviado

O que aconteceu ao correio enviado, tal como a página Análises da aplicação o mostra.

GET/analytics/sending

Executa a chamada real no seu espaço de trabalho.

GET /analytics/sending

O que aconteceu ao correio enviado, tal como a página Análises da aplicação o mostra.

Exemplo

Requer emails:read. O período é days, 30 a menos que diga o contrário e no máximo 365, ou minutes, que prevalece, e começa no início do seu intervalo mais antigo. grain divide-o em dias, horas ou minutos.

curl
curl "$OE/analytics/sending?days=7" -H "$AUTH"
Resposta
{  "object": "sending_analytics",  "since": "2026-09-26T00:00:00.000Z",  "until": "2026-10-02T09:41:00.000Z",  "grain": "day",  "offsetMinutes": 0,  "totals": {    "sends": 412,    "testSends": 3,    "recipients": 498,    "delivered": 486,    "failed": 1,    "bounced": 8,    "complained": 1,    "uncertain": 0,    "pending": 2  },  "days": [    { "day": "2026-10-01", "sent": 74, "delivered": 72, "failed": 0, "bounced": 2, "complained": 0 }  ],  "statuses": [{ "label": "sent", "count": 409 }],  "sources": [    { "label": "api", "count": 288 },    { "label": "composer", "count": 124 }  ],  "senders": [{ "label": "[email protected]", "count": 412 }],  "suppressed": [{ "label": "bounce", "count": 27 }]}

totals conta o que foi enviado e para quantos destinatários, e o que lhe aconteceu: entregue, falhado, devolvido, com queixas, incerto e ainda pendente. days tem o mesmo por intervalo. statuses, sources e senders contam os envios por estado, pela origem e pelo endereço com que saíram, e suppressed conta os endereços suprimidos pelo motivo.

Uma chave ou uma aplicação limitada a certos endereços conta apenas o correio enviado a partir desses endereços, e address restringe a contagem a um só endereço.

Referência