Saltar para a documentação
API

Análise das difusões

Como correram as difusões enviadas num período que termina agora, somadas e contadas por dia, hora ou minuto, com uma linha por difusão para as comparar: o separador Análise da página de difusões.

GET/broadcasts/analytics

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

GET /broadcasts/analytics

Como correram as difusões enviadas num período que termina agora, somadas e contadas por dia, hora ou minuto, com uma linha por difusão para as comparar: o separador Análise da página de difusões.

Exemplo

Requer emails:read. Omita broadcastIds para todas as difusões, ou indique até 50 separadas por vírgulas. O período é days (1 a 1095) ou minutes (1 a 1576800, que prevalece quando ambos são enviados), 30 dias por omissão. grain é day, hour ou minute, day por omissão, e offsetMinutes (-840 a 840) é o desvio de quem consulta em relação a UTC.

curl
curl "$OE/broadcasts/analytics?days=30" -H "$AUTH"
Resposta
{  "object": "broadcast_analytics",  "since": "2026-08-25T00:00:00.000Z",  "until": "2026-09-23T12:00:00.000Z",  "grain": "day",  "offsetMinutes": 0,  "broadcastIds": [],  "totals": {    "broadcasts": 2,    "recipients": 530,    "pending": 0,    "sent": 527,    "delivered": 519,    "bounced": 6,    "complained": 1,    "failed": 3,    "opened": 241,    "clicked": 66,    "unsubscribed": 4,    "opens": 377,    "clicks": 90  },  "series": [    { "bucket": "2026-09-09", "sent": 117, "delivered": 115, "opened": 54, "clicked": 14, "unsubscribed": 1 },    { "bucket": "2026-09-23", "sent": 410, "delivered": 404, "opened": 187, "clicked": 52, "unsubscribed": 3 }  ],  "broadcasts": [    {      "id": "brd_5a8c1e3f7b2d94a06c8e1f3b",      "subject": "The September release is out",      "status": "sent",      "sentAt": "2026-09-23T12:00:00.000Z",      "recipients": 412,      "sent": 410,      "delivered": 404,      "opened": 187,      "clicked": 52,      "unsubscribed": 3    },    {      "id": "brd_2e7d9b4c1a8f60e35d2c7b91",      "subject": "What changed in August",      "status": "sent",      "sentAt": "2026-09-09T09:30:00.000Z",      "recipients": 118,      "sent": 117,      "delivered": 115,      "opened": 54,      "clicked": 14,      "unsubscribed": 1    }  ]}

Uma cópia conta quando foi enviada dentro do período, e tudo o que lhe aconteceu depois conta com ela. As difusões em modo de teste ficam de fora.

totals e series somam as difusões em broadcastIds, ou todas quando está vazio. broadcasts lista sempre todas as difusões do período, da mais recente para a mais antiga, com as mesmas contagens de totals, aqui abreviadas, para que as possa comparar ou escolher ids.

opened, clicked e unsubscribed contam pessoas, enquanto opens e clicks contam eventos. series é esparsa, da mais antiga para a mais recente, e conta cada pessoa uma vez, na primeira vez que lhe aconteceu.

Mais de 50 ids dá 422 invalid_parameter, e um id sem cópias no período não soma nada. Uma chave limitada a determinados endereços ou domínios só lê as difusões enviadas de um endereço ou domínio que detém.

A sua caixa de entrada,
nos seus termos.

Infraestrutura de email para empresas, IA, agentes e correio pessoal. Feita para escala, privacidade e controlo. Tudo o que o email devia ter tido desde o primeiro dia.

© 2026 OpenEmail. Todos os direitos reservados.