दस्तावेज़ पर जाएँ
API

Broadcast आँकड़े

broadcast कैसा रहा: भेजी गई, डिलीवर हुई, बाउंस हुई, स्पैम के रूप में रिपोर्ट हुई और विफल हुई कॉपियाँ, और कितने लोगों ने खोला, क्लिक किया और unsubscribe किया, कुल योग के रूप में और `grain` के हिसाब से कटी series के रूप में।

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

असली कॉल आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।

GET /broadcasts/{id}/stats

broadcast कैसा रहा: भेजी गई, डिलीवर हुई, बाउंस हुई, स्पैम के रूप में रिपोर्ट हुई और विफल हुई कॉपियाँ, और कितने लोगों ने खोला, क्लिक किया और unsubscribe किया, कुल योग के रूप में और grain के हिसाब से कटी series के रूप में।

पैरामीटर

idstringआवश्यक
पाथ में। `POST /broadcasts` या `GET /broadcasts` से मिला एक `brd_` id।
grainstring
series के bucket की चौड़ाई: `minute`, `hour` या `day`। डिफ़ॉल्ट `hour`।
offsetMinutesinteger
UTC से पूर्व की ओर मिनट, जिनमें buckets काटे जाएँ, -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 events को गिनते हैं। pending उन कॉपियों को गिनता है जो अभी कतार में, शेड्यूल या भेजी जा रही हैं, और failed उन कॉपियों को जो विफल या रद्द हुईं।

series विरल है और सबसे पुराना पहले: हर उस grain के लिए एक bucket जिसमें कुछ हुआ। यह हर व्यक्ति को एक बार गिनती है, उस पहले समय पर जब उसके साथ यह हुआ, इसलिए इसका जोड़ कुल योग के बराबर होता है।

bucket माँगे गए offset में YYYY-MM-DD, YYYY-MM-DDTHH या YYYY-MM-DDTHH:MM होता है।

अस्वीकृतियाँ

स्थितिकोडकब
400invalid_cursorप्राप्तकर्ताओं की सूची पर, कोई cursor जो उस सूची ने नहीं दिया।
403insufficient_scopeकुंजी के पास emails:read नहीं है।
404broadcast_not_foundid इस वर्कस्पेस के किसी broadcast का नाम नहीं देता, या कुंजी कुछ ख़ास पतों या डोमेन तक सीमित है और broadcast ऐसी जगह से भेजा गया जो उसके पास नहीं है।
404recipient_not_foundGET /broadcasts/{id}/recipients/{emailId} पर, कोई emailId जो इस broadcast की कॉपी नहीं है।