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

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

messages:list

Anchor link to

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

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

الترويسات
Anchor link to
الاسم
مطلوب
الوصف
Authorizationنعمرمز Server 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").
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عدد النتائج لكل صفحة (≤ 1000).
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",          // التنسيق المطلوب: 2000-01-01
        "date_to": "string"             // التنسيق المطلوب: 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",             // رمز الحملة
      "messages_ids": [],               // معرفات الرسائل
      "messages_codes": [],             // رموز الرسائل
      "application": "string"           // رمز تطبيق Pushwoosh
    },
    "params": {
      "with_details": true,             // إضافة تفاصيل الرسالة إلى الاستجابة (كائن "details")
      "with_metrics": true              // إضافة مقاييس الرسالة إلى الاستجابة (كائن "metrics")
    },
    "per_page": 20,                     // <= 1000
    "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": [               // شروط الوسم (انظر /developer/api-reference/messages-api/#tag-conditions)
            TAG_CONDITION1,
            TAG_CONDITION2,
            ...,
            TAG_CONDITIONN
          ],
          "conditions_operator": "AND", // عامل منطقي لمصفوفات الشروط؛ القيم الممكنة: 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": [              // شروط الوسم (انظر Messages-api - tag-conditions)
          TAG_CONDITION1,
          TAG_CONDITION2,
          ...,
          TAG_CONDITIONN
        ],
        "conditions_operator": "AND" // عامل منطقي لمصفوفات الشروط؛ القيم الممكنة: 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

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

معلمات نص الطلب
Anchor link to
اسم المعلمة
النوع
الوصفمطلوب
message_codestringرمز الرسالة الذي تم الحصول عليه من استجابات واجهة برمجة التطبيقات /createMessage.نعم
platforms[int]المنصاتلا
مثال على الطلب
Anchor link to
{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // مطلوب. معرف رسالة فريد
  "platforms": [1, 3, 7, 10, 11, 12]          // اختياري. قائمة برموز المنصات
}
حقول الاستجابة
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",  // الطابع الزمني للمقاييس بتنسيق "YYYY-MM-DD HH:MM:SS"
    "platform": 3,                       // رمز المنصة
    "sends": "55902",                    // عدد الرسائل المرسلة
    "opens": "382",                      // عدد الرسائل المفتوحة
    "deliveries": "22931",               // عدد الرسائل المسلمة
    "inbox_opens": "0",                  // عدد الرسائل المفتوحة في صندوق الوارد
    "unshowable_sends": "2",             // عدد الرسائل التي لا يمكن عرضها
    "errors": "0"                        // عدد الأخطاء التي تمت مواجهتها
  }],
  "conversion": {
    "sends": "55902",                    // إجمالي عدد الرسائل المرسلة
    "opens": "772",                      // إجمالي عدد الرسائل المفتوحة
    "events": [{
      "name": "cart_add",                // اسم الحدث
      "hits": "96",                      // عدد مرات الوصول للحدث
      "conversion": 0.12,                // معدل التحويل بالنسبة لعمليات الفتح
      "revenue": 0                       // الإيرادات الناتجة عن الحدث (فقط للأحداث التي تحتوي على سمات المبلغ/العملة)
    }]
  }
}

getDeliveryFunnel

Anchor link to

يعرض مسار التسليم لرسالة واحدة: الجمهور ← المرسلة ← الناجحة ← المسلمة ← المفتوحة، مع تفصيل لمكان فقدان الجمهور في كل مرحلة.

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

الترويسات
Anchor link to
الاسم
مطلوب
الوصف
Authorizationمطلوبرمز الوصول إلى واجهة برمجة التطبيقات من لوحة تحكم Pushwoosh.
معلمات نص الطلب
Anchor link to
الاسم
مطلوب
النوع
الوصف
message_codeنعمStringرمز الرسالة الذي تم الحصول عليه من استجابات واجهة برمجة التطبيقات /createMessage.
timestamp_fromنعمString (RFC 3339 date-time)بداية النطاق الزمني للتقرير، على سبيل المثال "2026-08-01T00:00:00Z". يجب أن يكون قبل timestamp_to.
timestamp_toنعمString (RFC 3339 date-time)نهاية النطاق الزمني للتقرير، على سبيل المثال "2026-08-04T00:00:00Z".
platformsلاArray of Integerفلتر اختياري لـ معرف المنصة.
مثال على الطلب
Anchor link to
{
  "message_code": "A444-AAABBBCC-00112233",  // مطلوب، رمز الرسالة الذي تم الحصول عليه من استجابة /createMessage
  "timestamp_from": "2026-08-01T00:00:00Z",  // مطلوب، يجب أن يكون قبل timestamp_to
  "timestamp_to": "2026-08-04T00:00:00Z",    // مطلوب
  "platforms": [1, 3, 7]                     // اختياري، قائمة برموز المنصات
}
حقول الاستجابة
Anchor link to
الاسمالنوعالوصف
funnelarrayمراحل المسار، يتم إرجاعها دائمًا بهذا الترتيب: STAGE_AUDIENCE, STAGE_SENT, STAGE_SUCCESSFUL, STAGE_DELIVERED, STAGE_OPENS.
stagestringاسم مرحلة المسار.
countstringالعدد الإجمالي للمرحلة.
piecesarrayتفصيل لـ count إلى فئات. يتم حذف الفئة التي يكون عددها صفرًا بدلاً من إرجاعها كـ 0.
pieces[].kindstringكيف يرتبط الجزء بإجمالي المرحلة: KIND_PASSED (انتقل إلى المرحلة التالية)، KIND_REASON (تم استبعاده لهذا السبب)، أو KIND_SUBSET (جزء من المرحلة، وليس مجموعًا منفصلاً).
pieces[].categorystringفئة التفصيل، على سبيل المثال INVALID_TOKEN, FREQUENCY_CAPPING, CONTROL_GROUP — انظر جدول المراحل أدناه.
pieces[].countstringالعدد لهذه الفئة.
مراحل المسار
Anchor link to
المرحلةمعنى countpieces
STAGE_AUDIENCEالأجهزة التي تم أخذها للمعالجة.KIND_PASSED ELIGIBLE_AUDIENCE (انتقل إلى STAGE_SENT)؛ KIND_REASON: FREQUENCY_CAPPING, CONTROL_GROUP, UNSUBSCRIBED, BOUNCED, COMPLAINT, FILTERED_BY_CATEGORY
STAGE_SENTتمت محاولة التسليم.KIND_PASSED SUCCESSFUL (مقبول من قبل المزود)؛ KIND_REASON: INVALID_TOKEN, NO_TOKEN, NO_DEVICE, PLATFORM_DISABLED, QUOTA_EXCEEDED, INVALID_CONTENT, INVALID_CONFIGURATION, INTERNAL_ERROR, PROVIDER_ERROR (أخطاء مزود غير مصنفة)
STAGE_SUCCESSFULمقبول من قبل المزود.KIND_PASSED SHOWABLE؛ KIND_REASON NOTIFICATIONS_DISABLED
STAGE_DELIVEREDالأجهزة الفريدة التي أكدت التسليم.لا شيء
STAGE_OPENSالأجهزة الفريدة التي فتحت.KIND_SUBSET MACHINE_OPENS_AMPP (عمليات الفتح التي تم تشغيلها بواسطة أتمتة AMP، وليست فتحًا حقيقيًا من قبل المستخدم)
مثال على الاستجابة
Anchor link to
{
  "funnel": [
    {
      "stage": "STAGE_AUDIENCE",
      "count": "600000",
      "pieces": [
        { "kind": "KIND_PASSED", "category": "ELIGIBLE_AUDIENCE", "count": "580000" },
        { "kind": "KIND_REASON", "category": "FREQUENCY_CAPPING", "count": "14000" },
        { "kind": "KIND_REASON", "category": "CONTROL_GROUP", "count": "6000" }
      ]
    },
    {
      "stage": "STAGE_SENT",
      "count": "580000",
      "pieces": [
        { "kind": "KIND_PASSED", "category": "SUCCESSFUL", "count": "560000" },
        { "kind": "KIND_REASON", "category": "INVALID_TOKEN", "count": "18000" },
        { "kind": "KIND_REASON", "category": "PROVIDER_ERROR", "count": "2000" }
      ]
    },
    {
      "stage": "STAGE_SUCCESSFUL",
      "count": "560000",
      "pieces": [
        { "kind": "KIND_PASSED", "category": "SHOWABLE", "count": "540000" },
        { "kind": "KIND_REASON", "category": "NOTIFICATIONS_DISABLED", "count": "20000" }
      ]
    },
    {
      "stage": "STAGE_DELIVERED",
      "count": "168316",
      "pieces": []
    },
    {
      "stage": "STAGE_OPENS",
      "count": "30514",
      "pieces": [
        { "kind": "KIND_SUBSET", "category": "MACHINE_OPENS_AMPP", "count": "412" }
      ]
    }
  ]
}
رموز الاستجابة والأمثلة 
{
  "funnel": []
}

getMessageLog

Anchor link to

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

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

الترويسات
Anchor link to
الاسم
مطلوب
الوصف
Authorizationمطلوبرمز الوصول إلى واجهة برمجة التطبيقات من لوحة تحكم 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", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted".
platformsلاArrayمصفوفة من المنصات المستهدفة لتصفية النتائج. القيم الممكنة: "ios", "android", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "huawei_android".
مثال على الطلب
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",  // اختياري، رمز للترقيم
   "limit": 1000,                                  // اختياري، الحد الأقصى لعدد الإدخالات لاستجابة واحدة
   "application_code": "XXXXX-XXXXX",              // رمز تطبيق Pushwoosh
   "message_code": "A444-AAABBBCC-00112233",       // اختياري، رمز الرسالة الذي تم الحصول عليه من طلب /createMessaage
   "message_id": 1234567890,                       // اختياري، معرف الرسالة الذي تم الحصول عليه من لوحة تحكم Pushwoosh
   "campaign_code": "AAAAA-XXXXX",                 // اختياري، رمز حملة للحصول على السجل لها
   "hwid": "aaazzzqqqqxxx",                        // اختياري، معرف الجهاز لجهاز معين مستهدف برسالة
   "user_id": "user_123",                          // اختياري، معرف مستخدم مستهدف بالرسالة
   "date_from": "2000-01-25 00:00:00",             // اختياري، بداية فترة الإحصائيات
   "date_to": "2000-02-10 23:59:59",               // اختياري، نهاية فترة الإحصائيات
   "actions": ["opened", "inbox_opened"],          // اختياري، يستخدم لتصفية النتائج. القيم الممكنة: "sent", "opened", "delivered", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". ستتضمن الاستجابة جميع الرسائل ذات الإجراء (الإجراءات) المحددة.
   "platforms": ["ios", "chrome"]                  // اختياري، يستخدم لتصفية النتائج. القيم الممكنة: "ios", "android", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "huawei android"
}'
رموز الاستجابة والأمثلة 
{
  "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"
  }]
}

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

Anchor link to

linksInteractions

Anchor link to

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

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

الترويسات
Anchor link to
الاسم
مطلوب
الوصف
Authorizationنعمرمز الوصول إلى واجهة برمجة التطبيقات من لوحة تحكم 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 الخاص بها فقط في استجابة واجهة برمجة التطبيقات. على سبيل المثال، إذا كان بريدك الإلكتروني يحتوي على روابط مثل 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",           // التنسيق المطلوب: 2000-01-01
         "date_to": "string"              // التنسيق المطلوب: 2000-01-01
      },
      "campaign": "string",               // رمز الحملة (يمكنك تحديد application أو messages_ids أو message_codes بدلاً من ذلك)
      "application": "string",            // رمز التطبيق (يمكنك تحديد campaign أو messages_ids أو message_codes بدلاً من ذلك)
      "messages_ids": [],                 // معرفات الرسائل (يمكنك تحديد application أو campaign أو message_codes بدلاً من ذلك)
      "messages_codes": [],               // رموز الرسائل (يمكنك تحديد application أو campaign أو message_ids بدلاً من ذلك)
      "link_template": "string",          // قالب الرابط (مطلوب إذا تم تحديد application أو campaign)
      "email_content_code": "string"      // معرف فريد لمحتوى البريد الإلكتروني.
   },
   "params": {
      "with_full_links": true             // حدد ما إذا كنت تريد إظهار إحصائيات مفصلة. سيتم تمرير قائمة بالروابط الكاملة مع الإحصائيات في مصفوفة full_links.
   }
}'
رموز الاستجابة والأمثلة
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نعمرمز الوصول إلى واجهة برمجة التطبيقات من لوحة تحكم 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 الخاص بها فقط في استجابة واجهة برمجة التطبيقات. على سبيل المثال، إذا كان بريدك الإلكتروني يحتوي على روابط مثل 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",         // التنسيق المطلوب: 2000-01-01
         "date_to": "string"            // التنسيق المطلوب: 2000-01-01
      },
      "campaign": "string",             // رمز الحملة (يمكنك تحديد application أو messages_ids أو message_codes بدلاً من ذلك)
      "application": "string",          // رمز التطبيق (يمكنك تحديد campaign أو messages_ids أو message_codes بدلاً من ذلك)
      "messages_ids": [],               // معرفات الرسائل (يمكنك تحديد application أو campaign أو message_codes بدلاً من ذلك)
      "messages_codes": [],             // رموز الرسائل (يمكنك تحديد application أو campaign أو message_ids بدلاً من ذلك)
      "link_template": "string",        // قالب الرابط (مطلوب إذا تم تحديد application أو campaign)
      "email_content_code": "string"    // معرف فريد لمحتوى البريد الإلكتروني.
   },
   "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

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

معلمات نص الطلب
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",               // مطلوب. رمز تطبيق Pushwoosh
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // مطلوب إذا لم يتم توفير الحملة أو نطاق التاريخ.
                                              //          معرف رسالة فريد
  "campaign": "XXXXX-XXXXX",                  // مطلوب إذا لم يتم توفير message_code أو نطاق التاريخ.
                                              //          رمز الحملة
  "date_from": "2024-07-20T00:00:00.000Z",    // مطلوب إذا لم يتم توفير message_code أو الحملة.
                                              //          تاريخ البدء بتنسيق ISO 8601 "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "date_to": "2024-07-20T00:00:00.000Z",      // مطلوب إذا لم يتم توفير message_code أو الحملة.
                                              //          تاريخ الانتهاء بتنسيق ISO 8601 "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "per_page": 1000,                           // مطلوب. عدد النتائج لكل صفحة، بحد أقصى 5000
  "page": 5,                                  // اختياري. رقم الصفحة، بدءًا من الصفر
  "type": "Softbounce"                        // اختياري. نوع الارتداد: 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,                             // العدد الإجمالي للصفوف.
  "bounced_emails": [{
    "email": "example@example.com",        // عنوان البريد الإلكتروني الذي ارتد
    "date": "2024-07-20T00:00:00.000Z",    // تاريخ الارتداد بتنسيق ISO 8601
    "reason": "Invalid recipient address", // سبب الارتداد
    "type": "Hardbounce"                   // نوع الارتداد: Complaint, Softbounce, Hardbounce
  }]
}