انتقل إلى المحتوى
أدلة المستخدم أدلة كيفية الاستخدام الدعم طلب عرض توضيحي تسجيل الدخول
Pushwoosh.com

إحصائيات الرسائل

messages:list

Anchor link to

يعرض قائمة الرسائل المرسلة.

POST https://api.pushwoosh.com/api/v2/messages:list

ترويسات
Anchor link to
الاسم
مطلوب
الوصف
Authorizationنعمرمز API للخادم. يجب توفيره بالتنسيق التالي: Authorization: Api <Server Key>.
معلمات نص الطلب
Anchor link to
الاسم
مطلوب
النوع
الوصف
platformsلاArrayمنصات الرسائل. القيم الممكنة: "IOS", "ANDROID", "OSX", "WINDOWS", "AMAZON", "SAFARI", "CHROME", "FIREFOX", "IE", "EMAIL", "HUAWEI_ANDROID", "SMS".
date_rangeلاObjectفترة التقرير، مفلترة حسب تاريخ إنشاء الرسالة. يجب أن يتبع date_from و date_to تنسيق YYYY-MM-DD (على سبيل المثال، "2000-01-01")؛ يتم تضمين كلا اليومين بالكامل، لذا فإن تعيين date_from و date_to على نفس التاريخ يعيد ذلك اليوم بأكمله. يتم تفسير التواريخ بتوقيت UTC، وليس في المنطقة الزمنية لحسابك.
campaignلاStringرمز الحملة
filtersنعمObjectفلاتر الرسائل.
sourceلاStringمصدر الرسالة. على سبيل المثال: AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS.
messages_codesلاArrayرموز الرسائل التي تم الحصول عليها من استجابات واجهة برمجة التطبيقات /createMessage.
messages_idsلاArrayمعرفات الرسائل التي تم الحصول عليها من سجل الرسائل
paramsلاObjectحدد ما إذا كنت تريد إظهار تفاصيل الرسالة ومقاييسها. اضبط with_details: true لتضمين كائن "details" و with_metrics: true لتضمين كائن "metrics" في الاستجابة.
applicationنعمStringرمز تطبيق Pushwoosh.
per_pageلاIntegerعدد النتائج لكل صفحة، من 1 إلى 499. احذف المعلمة للحصول على حجم الصفحة الافتراضي وهو 500 نتيجة؛ يتم رفض تمرير 500 أو أكثر بشكل صريح مع 400.
pageلاIntegerرقم الصفحة المستند إلى الصفر للترقيم. انظر حد الترقيم العميق أدناه.
مثال على الطلب
Anchor link to
{
    "filters": {
      "platforms": [],                  // IOS, ANDROID, OSX, WINDOWS, AMAZON, SAFARI, CHROME, FIREFOX, IE, EMAIL, HUAWEI_ANDROID, SMS
      "date_range": {
        "date_from": "string",          // Required format: 2000-01-01
        "date_to": "string"             // Required format: 2000-01-01
      },
      "source": "API",                  // AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS
      "campaign": "string",             // Campaign code
      "messages_ids": [],               // Message IDs
      "messages_codes": [],             // Message codes
      "application": "string"           // Pushwoosh application code
    },
    "params": {
      "with_details": true,             // Add message details to the response ("details" object)
      "with_metrics": true              // Add message metrics to the response ("metrics" object)
    },
    "per_page": 20,                     // <= 499
    "page": 0
}
رموز الاستجابة والأمثلة 
{
  "total": 0,
  "items": [{
    "id": 0,
    "code": "string",
    "created_date": "string",
    "send_date": "string",
    "status": "string",
    "platforms": [],
    "source": "string",
    "push_info": {
      "details": {
        "title": "string",
        "filter_name": "string",
        "filter_code": "string",
        "content": {
          "key": "value"
        },
        "platform_parameters": {
          "android_header": "string",
          "android_root_params": {
            "key": "value"
          },
          "ios_title": "string",
          "ios_subtitle": "string",
          "ios_root_params": {
            "key": "value"
          },
          "chrome_header": "string",
          "chrome_root_params": {
            "key": "value"
          },
          "firefox_header": "string",
          "firefox_root_params": {
            "key": "value"
          },
          "conditions": [               // tag conditions (see /developer/api-reference/messages-api/#tag-conditions)
            TAG_CONDITION1,
            TAG_CONDITION2,
            ...,
            TAG_CONDITIONN
          ],
          "conditions_operator": "AND", // logical operator for conditions arrays; possible values: AND, OR
          "data": {
            "key": "value"
          }
        },
        "follow_user_timezone": true
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "inbox_opens": 0,
        "unshowable_sends": 0,
        "errors": 0,
        "platform": 0
      }]
    },
    "email_info": {
      "details": {
        "template": "string",
        "filter_name": "string",
        "filter_code": "string",
        "subject": {
          "key": "value"
        },
        "from_name": "string",
        "from_email": "string",
        "reply_name": "string",
        "reply_email": "string",
        "follow_user_timezone": true,
        "conditions": [              // tag conditions (see Messages-api - tag-conditions)
          TAG_CONDITION1,
          TAG_CONDITION2,
          ...,
          TAG_CONDITIONN
        ],
        "conditions_operator": "AND" // logical operator for conditions arrays; possible values: AND, OR
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "hard_bounces": 0,
        "soft_bounces": 0,
        "rejects": 0,
        "confirmed_sends": 0,
        "unsubs": 0,
        "complaints": 0,
        "errors": 0
      }]
    }
  }]
}

totalsByIntervals

Anchor link to

يعيد المقاييس وبيانات التحويل بناءً على رمز الرسالة، مجمعة حسب الساعة.

POST https://api.pushwoosh.com/api/v2/statistics/messages/totalsByIntervals

التفويض
Anchor link to

يتم التعامل مع التفويض عبر رمز الوصول إلى API في ترويسة الطلب.

معلمات نص الطلب
Anchor link to
اسم المعلمة
النوع
الوصفمطلوب
message_codestringرمز الرسالة الذي تم الحصول عليه من استجابات واجهة برمجة التطبيقات /createMessage.نعم
platforms[int]المنصاتلا
مثال على الطلب
Anchor link to
{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // required. Unique message identifier
  "platforms": [1, 3, 7, 10, 11, 12]          // optional. List of platform codes
}
حقول الاستجابة
Anchor link to
الاسمالنوعالوصف
metricsarrayيحتوي على مصفوفة من مقاييس الرسائل
timestampstringوقت المقياس.
platformintرمز المنصة (مثل iOS، Android).
sendsstringعدد الرسائل المرسلة.
opensstringعدد الرسائل المفتوحة.
deliveriesstringعدد الرسائل المسلمة.
inbox_opensstringعدد مرات فتح البريد الوارد.
unshowable_sendsstringعدد الرسائل المقبولة للأجهزة التي تم إيقاف تشغيل الإشعارات فيها في إعدادات نظام التشغيل. لا يتم عرض أي لافتة، ولكن الرسالة لا تزال تصل إلى التطبيق، وتظهر في صندوق الوارد للرسائل إذا كان الإرسال يحتوي على حفظ الرسالة في صندوق الوارد ممكّنًا. تُحتسب كإرسالات ناجحة، وليس كأخطاء.
errorsstringعدد الأخطاء.
conversionobjectيحتوي على بيانات التحويل
sendsstringإجمالي عدد الرسائل المرسلة.
opensstringإجمالي عدد الرسائل المفتوحة.
eventsarrayمصفوفة من الأحداث مع إحصائياتها
namestringاسم الحدث (على سبيل المثال، إضافة إلى السلة).
hitsstringعدد مرات الوصول.
conversionfloatمعدل التحويل بالنسبة لعمليات الفتح.
revenuefloatالإيرادات (فقط للأحداث التي تحتوي على سمات __amount و __currency).
مثال على الاستجابة
Anchor link to
{
  "metrics": [{
    "timestamp": "2024-08-03 15:00:00",  // Timestamp of the metrics in "YYYY-MM-DD HH:MM:SS" format
    "platform": 3,                       // Platform code
    "sends": "55902",                    // Number of messages sent
    "opens": "382",                      // Number of messages opened
    "deliveries": "22931",               // Number of messages delivered
    "inbox_opens": "0",                  // Number of messages opened in the inbox
    "unshowable_sends": "2",             // Sent to devices with notifications turned off, no banner shown
    "errors": "0"                        // Number of errors encountered
  }],
  "conversion": {
    "sends": "55902",                    // Total number of messages sent
    "opens": "772",                      // Total number of messages opened
    "events": [{
      "name": "cart_add",                // Name of the event
      "hits": "96",                      // Number of hits for the event
      "conversion": 0.12,                // Conversion rate relative to opens
      "revenue": 0                       // Revenue generated by the event (only for events with amount/currency attributes)
    }]
  }
}

getMessageLog

Anchor link to

يعرض معلومات مفصلة حول الرسائل المرسلة.

POST https://api.pushwoosh.com/api/v2/statistics/getMessageLog

ترويسات
Anchor link to
الاسم
مطلوب
الوصف
Authorizationمطلوبرمز الوصول إلى API من لوحة تحكم Pushwoosh.
معلمات نص الطلب
Anchor link to
الاسم
مطلوب
النوع
الوصف
message_idلاIntegerحدد أحداث الرسائل حسب معرف الرسالة الذي تم الحصول عليه من سجل الرسائل. مثال: 12345678900.
message_codeلاStringحدد أحداث الرسائل حسب رمز الرسالة الذي تم الحصول عليه من استجابات واجهة برمجة التطبيقات /createMessage. مثال: "A444-AAABBBCC-00112233".
campaign_codeلاStringحدد أحداث الرسائل حسب رمز الحملة المحدد في حمولة رسالتك. مثال: "AAAAA-XXXXX".
hwidلاString or Arrayحدد أحداث الرسائل حسب HWID (معرف الجهاز) أو مصفوفة من HWIDs.
date_fromمطلوب إذا لم يتم توفير message_id أو message_code أو campaign_codeDatetimeتاريخ البدء لتصفية الرسائل. التنسيق: "YYYY-MM-DD HH:MM:SS". مثال: "2000-01-25 00:00:00".
date_toمطلوب إذا لم يتم توفير message_id أو message_code أو campaign_codeDatetimeتاريخ الانتهاء لتصفية الرسائل. التنسيق: "YYYY-MM-DD HH:MM:SS". مثال: "2000-01-26 00:00:00".
limitلاIntegerالحد الأقصى لعدد أحداث الرسائل التي يتم إرجاعها في استجابة واحدة. القيمة القصوى: 100000.
pagination_tokenلاStringرمز الترقيم الذي تم الحصول عليه من استجابة /getMessageLog سابقة. استخدمه لاسترداد نتائج إضافية.
user_idلاStringحدد أحداث الرسائل حسب معرف المستخدم المخصص. انظر /registerUser لمزيد من التفاصيل.
application_codeنعمStringحدد أحداث الرسائل حسب رمز تطبيق Pushwoosh
actionsلاArrayتصفية النتائج حسب إجراءات رسائل محددة. القيم الممكنة: "sent", "delivered", "opened", "reject", "create", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". يتم استبعاد أحداث "create" من الاستجابة افتراضيًا. قم بتضمين "create" في هذه المصفوفة لرؤيتها. تتطلب أحداث "delivered" بالإضافة إلى ذلك تمكين إحصائيات التسليم على الحساب.
platformsلاArrayمصفوفة من المنصات المستهدفة لتصفية النتائج. القيم الممكنة: "unknown", "ios", "blackberry", "android", "windows phone", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "fb messenger", "baidu android", "huawei android", "sms", "xiaomi", "web", "whatsapp", "line", "kakao", "telegram", "apple wallet", "google wallet", "viber".
message_typeلاStringتصفية النتائج حسب تدفق الرسائل. "all" (الافتراضي إذا تم حذفه) يعيد كل شيء، "broadcast" يعيد فقط الرسائل الجماعية (message_id != 0)، "transactional" يعيد فقط الرسائل التي تحتوي على message_id = 0، بما في ذلك تلك المرسلة من Customer Journey.
مثال على الطلب
Anchor link to
Terminal window
curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/getMessageLog' \
--header 'Authorization: Key API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "pagination_token": "PAGINATION_TOKEN_FROM_PREVIOUS_RESPONSE",  // optional, token for pagination
   "limit": 1000,                                  // optional, the max number of entries for a single response
   "application_code": "XXXXX-XXXXX",              // Pushwoosh app code
   "message_code": "A444-AAABBBCC-00112233",       // optional, message code obtained from /createMessaage request
   "message_id": 1234567890,                       // optional, message ID obtained from Pushwoosh Control Panel
   "campaign_code": "AAAAA-XXXXX",                 // optional, code of a campaign to get the log for
   "hwid": "aaazzzqqqqxxx",                        // optional, hardware ID of a specific device targeted with a message
   "user_id": "user_123",                          // optional, ID of a user targeted with the message
   "date_from": "2000-01-25 00:00:00",             // optional, start of the stats period
   "date_to": "2000-02-10 23:59:59",               // optional, end of the stats period
   "actions": ["opened", "inbox_opened"],          // optional, used for results filtration. Possible values: "sent", "delivered", "opened", "reject", "create", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". The response will include all the messages with the specified action(s).
   "platforms": ["ios", "chrome"],                 // optional, used for results filtration, lowercase only. Possible values: "unknown", "ios", "blackberry", "android", "windows phone", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "fb messenger", "baidu android", "huawei android", "sms", "xiaomi", "web", "whatsapp", "line", "kakao", "telegram", "apple wallet", "google wallet", "viber"
   "message_type": "broadcast"                     // optional, "all" (default), "broadcast" (message_id != 0), or "transactional" (message_id = 0, includes Customer Journey sends)
}'
رموز الاستجابة والأمثلة 
{
  "pagination_token": "PAGINATION_TOKEN_FOR_NEXT_REQUEST",
  "data": [{
    "timestamp": "2000-01-25T11:18:47Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "sent",
    "status": "success",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:18:49Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "delivered",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:23Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "opened",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:30Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "reject",
    "status": "failed",
    "error_reason": "invalid device token",
    "payload": "SOME_PAYLOAD_STRING"
  }]
}

يحمل كل إدخال في data أيضًا error_reason (سلسلة نصية، يتم ملؤها بسبب الفشل عندما تكون status هي "failed") و payload اختياري (سلسلة نصية).

يمكن أن تعود صفحة الاستجابة أقصر من limit المطلوب. هذا وحده لا يعني أن التصدير قد انتهى.

إحصائيات البريد الإلكتروني

Anchor link to

linksInteractions

Anchor link to

يعرض إحصائيات حول نقرات الروابط في رسائل البريد الإلكتروني

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions

ترويسات
Anchor link to
الاسم
مطلوب
الوصف
Authorizationنعمرمز الوصول إلى API من لوحة تحكم Pushwoosh.
معلمات نص الطلب
Anchor link to
الاسم
مطلوب
النوعالوصف
date_rangeلاObjectيحدد فترة التقرير. يحتوي على date_from و date_to.
filtersنعمObjectفلاتر البريد الإلكتروني.
applicationنعمStringرمز تطبيق Pushwoosh (بدلاً من ذلك، حدد campaign أو messages_ids أو message_codes).
messages_codesنعمArrayرموز الرسائل (بدلاً من ذلك، حدد application أو campaign أو messages_ids).
campaignنعمStringرمز الحملة (بدلاً من ذلك، حدد application أو messages_ids أو message_codes).
messages_idsنعمArrayمعرفات الرسائل (بدلاً من ذلك، حدد application أو campaign أو message_codes).
link_templateمطلوب إذا تم تحديد application أو campaign.Stringيقوم بتصفية تفاعلات روابط البريد الإلكتروني حسب الكلمة الرئيسية. سيتم إرجاع الروابط التي تتضمن النص المحدد في عنوان URL الخاص بها فقط في استجابة API. على سبيل المثال، إذا كان بريدك الإلكتروني يحتوي على روابط مثل https://example.com/news و https://example.com/shop، فإن تعيين “link_template”: “shop” سيعيد التفاعلات لـ https://example.com/shop فقط.
email_content_codeلاStringمعرف فريد لمحتوى البريد الإلكتروني.
paramsلاObjectيحدد خيارات استجابة إضافية. يتضمن with_full_links، الذي يضيف قائمة بالروابط الكاملة مع الإحصائيات.
مثال على الطلب
Anchor link to
Terminal window
curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",           // Required format: 2000-01-01
         "date_to": "string"              // Required format: 2000-01-01
      },
      "campaign": "string",               // Campaign code (you can specify application, messages_ids, or message_codes instead)
      "application": "string",            // Application code (you can specify campaign, messages_ids, or message_codes instead)
      "messages_ids": [],                 // Message IDs (you can specify application, campaign, or message_codes instead)
      "messages_codes": [],               // Message codes (you can specify application, campaign, or message_ids instead)
      "link_template": "string",          // Link template (required if application or campaign is specified)
      "email_content_code": "string"      // Unique identifier for the email content.
   },
   "params": {
      "with_full_links": true             // Specify whether to show detailed statistics. A list of full links with statistics will be passed in the full_links array.
   }
}'
رموز الاستجابة والأمثلة
Anchor link to
{
  "items": [{
    "template": "string",
    "link": "string",
    "title": "string",
    "clicks": 0,
    "full_links": [{
      "full_link": "string",
      "clicks": 0
    }]
  }]
}

linksInteractionsDevices

Anchor link to

يعرض المستخدمين الذين نقروا على الروابط في رسائل البريد الإلكتروني

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices

ترويسات
Anchor link to
الاسم
مطلوب
الوصف
Authorizationنعمرمز الوصول إلى API من لوحة تحكم Pushwoosh.
معلمات نص الطلب
Anchor link to
الاسم
مطلوب
النوعالوصف
date_rangeلاObjectيحدد فترة التقرير. يحتوي على date_from و date_to.
filtersنعمObjectفلاتر البريد الإلكتروني.
applicationنعمStringرمز تطبيق Pushwoosh (بدلاً من ذلك، حدد campaign أو messages_ids أو message_codes).
messages_codesنعمArrayرموز الرسائل (بدلاً من ذلك، حدد application أو campaign أو messages_ids).
campaignنعمStringرمز الحملة (بدلاً من ذلك، حدد application أو messages_ids أو message_codes).
messages_idsنعمArrayمعرفات الرسائل (بدلاً من ذلك، حدد application أو campaign أو message_codes).
link_templateمطلوب إذا تم تحديد application أو campaign.Stringيقوم بتصفية تفاعلات روابط البريد الإلكتروني حسب الكلمة الرئيسية. سيتم إرجاع الروابط التي تتضمن النص المحدد في عنوان URL الخاص بها فقط في استجابة API. على سبيل المثال، إذا كان بريدك الإلكتروني يحتوي على روابط مثل https://example.com/news و https://example.com/shop، فإن تعيين “link_template”: “shop” سيعيد التفاعلات لـ https://example.com/shop فقط.
email_content_codeلاStringمعرف فريد لمحتوى البريد الإلكتروني.
pageلاIntegerرقم الصفحة للترقيم.
per_pageلاIntegerعدد النتائج لكل صفحة (≤ 1000).
مثال على الطلب
Anchor link to
Terminal window
curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",         // Required format: 2000-01-01
         "date_to": "string"            // Required format: 2000-01-01
      },
      "campaign": "string",             // Campaign code (you can specify application, messages_ids, or message_codes instead)
      "application": "string",          // Application code (you can specify campaign, messages_ids, or message_codes instead)
      "messages_ids": [],               // Message IDs (you can specify application, campaign, or message_codes instead)
      "messages_codes": [],             // Message codes (you can specify application, campaign, or message_ids instead)
      "link_template": "string",        // Link template (required if application or campaign is specified)
      "email_content_code": "string"    // Unique identifier for the email content.
   },
   "per_page": 100,
   "page": 0
}'
رموز الاستجابة والأمثلة
Anchor link to
{
  "total": 0,
  "items": [{
    "timestamp": "string",
    "link": "string",
    "hwid": "string"
  }]
}

bouncedEmails

Anchor link to

POST https://api.pushwoosh.com/api/v2/statistics/emails/bouncedEmails

يوفر بيانات حول شكاوى البريد الإلكتروني، والارتدادات الناعمة، والارتدادات الصلبة، بما في ذلك التاريخ وعنوان البريد الإلكتروني وسبب كل ارتداد.

التفويض
Anchor link to

يتم التعامل مع التفويض عبر رمز الوصول إلى API في ترويسة الطلب.

معلمات نص الطلب
Anchor link to
اسم المعلمةالنوعالوصفمطلوب
applicationstringرمز تطبيق Pushwooshنعم
message_codestringرمز الرسالة.مطلوب إذا لم يتم توفير date range أو campaign
campaignstringرمز الحملة.مطلوب إذا لم يتم توفير message_code أو date range
date_fromstringتاريخ البدء للبيانات بالتنسيق YYYY-MM-DDTHH:MM:SS.000Z (معيار ISO 8601).مطلوب إذا لم يتم توفير message_code أو campaign
date_tostringتاريخ الانتهاء للبيانات بالتنسيق YYYY-MM-DDTHH:MM:SS.000Z (معيار ISO 8601).مطلوب إذا لم يتم توفير message_code أو campaign
per_pageintعدد الصفوف لكل صفحة، بحد أقصى 5000.نعم
pageintرقم الصفحة، بدءًا من الصفر.نعم
typestringنوع الارتداد: Complaint، Softbounce، Hardbounce.لا
مثال على الطلب
Anchor link to
{
  "application": "XXXXX-XXXXX",               // required. Pushwoosh app code
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // required if campaign or date range is not provided.
                                              //          Unique message identifier
  "campaign": "XXXXX-XXXXX",                  // required if message_code or date range is not provided.
                                              //          Campaign code
  "date_from": "2024-07-20T00:00:00.000Z",    // required if message_code or campaign is not provided.
                                              //          Start date in ISO 8601 format "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "date_to": "2024-07-20T00:00:00.000Z",      // required if message_code or campaign is not provided.
                                              //          End date in ISO 8601 format "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "per_page": 1000,                           // required. Number of results per page, maximum 5000
  "page": 5,                                  // optional. Page number, starting from zero
  "type": "Softbounce"                        // optional. The type of bounce: Complaint, Softbounce, Hardbounce
}
حقول الاستجابة
Anchor link to
اسم الحقلالنوعالوصف
totalintالعدد الإجمالي للصفوف.
bounced_emailsarrayمصفوفة من تفاصيل البريد الإلكتروني المرتد.
├── emailstringعنوان البريد الإلكتروني الذي ارتد.
├── datestringتاريخ الارتداد (التنسيق: YYYY-MM-DDTHH:MM:SS.000Z).
├── reasonstringسبب الارتداد.
└── typestringنوع الارتداد: Complaint، Softbounce، Hardbounce.
مثال على الاستجابة
Anchor link to
{
  "total": 25,                             // Total count of rows.
  "bounced_emails": [{
    "email": "example@example.com",        // Email address that bounced
    "date": "2024-07-20T00:00:00.000Z",    // Bounce date in ISO 8601 format
    "reason": "Invalid recipient address", // Reason for the bounce
    "type": "Hardbounce"                   // Type of bounce: Complaint, Softbounce, Hardbounce
  }]
}