Belgelere geç
API

Toplu gönderim istatistikleri

Toplu gönderimin nasıl gittiği: gönderilen, teslim edilen, geri dönen, spam olarak bildirilen ve başarısız olan kopyalar ile açan, tıklayan ve abonelikten çıkan kişi sayısı; toplamlar olarak ve `grain` ile bölünmüş bir seri olarak.

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

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

GET /broadcasts/{id}/stats

Toplu gönderimin nasıl gittiği: gönderilen, teslim edilen, geri dönen, spam olarak bildirilen ve başarısız olan kopyalar ile açan, tıklayan ve abonelikten çıkan kişi sayısı; toplamlar olarak ve grain ile bölünmüş bir seri olarak.

Parametreler

idstringzorunlu
Yolun içinde. `POST /broadcasts` ya da `GET /broadcasts` yanıtından gelen bir `brd_` kimliği.
grainstring
Serinin aralık genişliği: `minute`, `hour` ya da `day`. Varsayılan `hour`.
offsetMinutesinteger
Aralıkların bölüneceği, UTC'nin doğusundaki dakika sayısı, -840 ile 840 arası. Varsayılan 0. Yerel saat dilimi için `-new Date().getTimezoneOffset()` verin.

Örnek

emails:read gerekir.

curl
curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/stats?grain=day" -H "$AUTH"
Yanıt
{  "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 ve unsubscribed kişileri sayarken opens ve clicks olayları sayar. pending hâlâ kuyrukta, zamanlanmış ya da gönderilmekte olan kopyaları, failed ise başarısız olan ya da iptal edilen kopyaları sayar.

series seyrektir ve en eskiden başlar: bir şeyin olduğu her grain için bir aralık. Her kişiyi, başına ilk geldiği anda bir kez sayar, bu yüzden toplamı toplamlara eşittir.

bucket, istenen ofsette YYYY-MM-DD, YYYY-MM-DDTHH ya da YYYY-MM-DDTHH:MM biçimindedir.

Retler

DurumKodNe zaman
400invalid_cursorAlıcı listesinde, o listenin vermediği bir cursor.
403insufficient_scopeAnahtarda emails:read yok.
404broadcast_not_foundKimlik bu çalışma alanında hiçbir toplu gönderimi adlandırmıyor ya da anahtar belirli adreslerle veya alan adlarıyla sınırlı ve toplu gönderim onun sahip olmadığı birinden gönderilmiş.
404recipient_not_foundGET /broadcasts/{id}/recipients/{emailId} üzerinde, bu toplu gönderimin kopyası olmayan bir emailId.