Estatísticas da difusão
Como correu a difusão: cópias enviadas, entregues, devolvidas, denunciadas como spam e falhadas, e quantas pessoas abriram, clicaram e cancelaram a subscrição, em totais e numa série cortada por `grain`.
Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.
GET /broadcasts/{id}/stats
Como correu a difusão: cópias enviadas, entregues, devolvidas, denunciadas como spam e falhadas, e quantas pessoas abriram, clicaram e cancelaram a subscrição, em totais e numa série cortada por grain.
Parâmetros
idstringobrigatório- No caminho. Um id `brd_` de `POST /broadcasts` ou `GET /broadcasts`.
grainstring- Largura dos intervalos da série: `minute`, `hour` ou `day`. Por omissão, `hour`.
offsetMinutesinteger- Minutos a leste de UTC pelos quais cortar os intervalos, de -840 a 840. Por omissão, 0. Passe `-new Date().getTimezoneOffset()` para o fuso local.
Exemplo
Precisa de emails:read.
curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/stats?grain=day" -H "$AUTH"{ "object": "broadcast_stats", "broadcastId": "brd_5a8c1e3f7b2d94a06c8e1f3b", "grain": "day", "totals": { "recipients": 412, "pending": 0, "sent": 410, "delivered": 404, "bounced": 4, "complained": 1, "failed": 2, "opened": 187, "clicked": 52, "unsubscribed": 3, "opens": 296, "clicks": 71 }, "series": [ { "bucket": "2026-09-23", "delivered": 404, "opened": 161, "clicked": 45, "unsubscribed": 3 }, { "bucket": "2026-09-24", "delivered": 0, "opened": 26, "clicked": 7, "unsubscribed": 0 } ]}opened, clicked e unsubscribed contam pessoas, enquanto opens e clicks contam eventos. pending conta as cópias ainda em fila, agendadas ou a enviar, e failed as cópias que falharam ou foram canceladas.
series é esparsa e começa pelas mais antigas: um intervalo por grain em que algo aconteceu. Conta cada pessoa uma vez, na primeira vez que lhe aconteceu, por isso a soma bate certo com os totais.
bucket é YYYY-MM-DD, YYYY-MM-DDTHH ou YYYY-MM-DDTHH:MM, no desvio pedido.
Recusas
| Estado | Código | Quando |
|---|---|---|
| 400 | invalid_cursor | Na lista de destinatários, um cursor que essa lista não entregou. |
| 403 | insufficient_scope | A chave não tem emails:read. |
| 404 | broadcast_not_found | O id não indica nenhuma difusão deste workspace, ou a chave está limitada a determinados endereços ou domínios e a difusão saiu de um que ela não tem. |
| 404 | recipient_not_found | Em GET /broadcasts/{id}/recipients/{emailId}, um emailId que não é uma cópia desta difusão. |