Перейти к документации
API

Статистика рассылки

Как прошла рассылка: копии отправленные, доставленные, с отказом доставки, отмеченные как спам и завершившиеся ошибкой, а также сколько человек открыли, кликнули и отписались, в виде итогов и ряда с шагом `grain`.

GETapi.openemail.uk/broadcasts/{id}/stats

Выполняет настоящий запрос в вашем рабочем пространстве, с вашим собственным ключом.

GET /broadcasts/{id}/stats

Как прошла рассылка: копии отправленные, доставленные, с отказом доставки, отмеченные как спам и завершившиеся ошибкой, а также сколько человек открыли, кликнули и отписались, в виде итогов и ряда с шагом grain.

Параметры

idstringобязательно
В пути запроса. Id `brd_` из `POST /broadcasts` или `GET /broadcasts`.
grainstring
Ширина интервала ряда: `minute`, `hour` или `day`. По умолчанию `hour`.
offsetMinutesinteger
Смещение к востоку от UTC в минутах, по которому режутся интервалы, от -840 до 840. По умолчанию 0. Передайте `-new Date().getTimezoneOffset()` для местного пояса.

Пример

Требует emails:read.

curl
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 и unsubscribed считают людей, а opens и clicks считают события. pending считает копии, которые ещё в очереди, запланированы или отправляются, а failed считает копии с ошибкой или отменённые.

series разрежен и идёт от старых к новым: один интервал на каждый grain, в котором что-то произошло. Каждый человек учитывается один раз, в момент, когда это впервые с ним произошло, поэтому сумма совпадает с итогами.

bucket имеет вид YYYY-MM-DD, YYYY-MM-DDTHH или YYYY-MM-DDTHH:MM в запрошенном смещении.

Отказы

СтатусКодКогда
400invalid_cursorВ списке получателей: cursor, который этот список не выдавал.
403insufficient_scopeУ ключа нет emails:read.
404broadcast_not_foundId не указывает на рассылку этого рабочего пространства, или ключ ограничен определёнными адресами или доменами, а рассылка отправлена с того, которого у него нет.
404recipient_not_foundВ GET /broadcasts/{id}/recipients/{emailId}: emailId, который не является копией этой рассылки.