پرش به مستندات
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 است، با همان اختلافی که خواسته شده.

ردها

وضعیتکدچه زمانی
400invalid_cursorدر فهرست گیرندگان، یک cursor که آن فهرست تحویل نداده است.
403insufficient_scopeکلید emails:read را ندارد.
404broadcast_not_foundشناسه هیچ ارسال گروهی‌ای را در این فضای کاری نام نمی‌برد، یا کلید به نشانی‌ها یا دامنه‌های خاصی محدود است و ارسال گروهی از جایی فرستاده شده که کلید آن را ندارد.
404recipient_not_foundدر GET /broadcasts/{id}/recipients/{emailId}، یک emailId که نسخه‌ای از این ارسال گروهی نیست.