API

إحصاءات البث

كيف كان أداء البث: النسخ المرسلة والمسلّمة والمرتدّة والمبلّغ عنها كرسائل مزعجة والفاشلة، وكم شخصًا فتح ونقر وألغى اشتراكه، كمجاميع وكسلسلة مقسّمة حسب `grain`.

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

ينفّذ الاستدعاء الحقيقي على مساحة عملك، بمفتاحك أنت.

GET /broadcasts/{id}/stats

كيف كان أداء البث: النسخ المرسلة والمسلّمة والمرتدّة والمبلّغ عنها كرسائل مزعجة والفاشلة، وكم شخصًا فتح ونقر وألغى اشتراكه، كمجاميع وكسلسلة مقسّمة حسب grain.

المعاملات

idstringمطلوب: في المسار. معرّف `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، بالإزاحة المطلوبة.

حالات الرفض

الحالة	الرمز	متى
400	`invalid_cursor`	في قائمة المستلمين، `cursor` لم تصدره تلك القائمة.
403	`insufficient_scope`	المفتاح لا يملك `emails:read`.
404	`broadcast_not_found`	المعرّف لا يسمّي أي بث في مساحة العمل هذه، أو أن المفتاح مقصور على عناوين أو نطاقات بعينها والبث أُرسل من واحد لا يملكه.
404	`recipient_not_found`	في `GET /broadcasts/{id}/recipients/{emailId}`، قيمة `emailId` ليست نسخة من هذا البث.