Customer Journey API

الحصول على إحصائيات Journey

GET https://journey.pushwoosh.com/api/journey/{id}/statistics/external

يحصل على إحصائيات journey محددة بواسطة معرفها (ID). يمكنك العثور على Journey ID في عنوان URL لصفحة لوحة journey (انظر الصورة أدناه).

قم بالمصادقة بواسطة API access token وأرسل طلباً فارغاً إلى نقطة النهاية (endpoint).

Headers

Name	Type	Description
Authorization	string	Journey ID

200: OK

{
  "payload": {
    "title": "Journey Title",
    "points": [{
      "pointTitle": "First Point Title",
      "campaignCode": "AAAAA-00000",
      "presetCode": "12345-67890",
      "pointStat": {
        "sent": 22648,
        "opened": 60,
        "uniqOpened": 60,
        "conversion": 0.26492405510420347
      }
    }]
  }
}

يحصل على إحصائيات journey محددة بواسطة معرفها (ID). يمكنك العثور على Journey ID في عنوان URL لصفحة لوحة journey:

قم بالمصادقة بواسطة API access token وأرسل طلباً فارغاً إلى نقطة النهاية (endpoint).

curl --location --request GET 'https://journey.pushwoosh.com/api/journey/<journey_id>/statistics/external' \
--header 'Authorization: Api <YOUR API TOKEN>'

{
  "payload": {
    "title": "Journey Title",
    "points": [{
      "pointTitle": "First Point Title",
      "campaignCode": "AAAAA-00000",
      "presetCode": "12345-67890",
      "pointStat": {
        "sent": 22648,
        "opened": 60,
        "uniqOpened": 60,
        "conversion": 0.26492405510420347
      }
    }]
  }
}

إزالة المستخدمين من Journeys

تسمح لك نقطة النهاية هذه بإزالة قائمة من المستخدمين من جميع Journeys النشطة أو محددة منها.

POST https://journey.pushwoosh.com/api/journey/drop-users/external

رؤوس الطلب (Request headers)

Header	Value
Content-Type	`application/json`
Authorization	`Bearer \<your_token\>`. يجب تضمين رمز مصادقة صالح في رأس `Authorization`.

جسم الطلب (Request body)

أرسل كائن JSON بالحقول التالية:

Field	Type	Required	Description
`user_ids`	`string[]`	نعم	قائمة User IDs لإزالتها من Journeys.
`journey_uuids`	`string[]`	مطلوب إذا لم يتم توفير `all_journeys` أو كانت false.	قائمة UUIDs الخاصة بـ Journey لإزالة المستخدمين منها.
`all_journeys`	`boolean`	مطلوب إذا لم يتم توفير `journey_uuids`.	إذا كانت true، ستتم إزالة المستخدمين من جميع Journeys. إذا كانت false، يجب توفير `journey_uuids`.

ملاحظة: يجب توفير واحد على الأقل من all_journeys (مضبوطة على true) أو journey_uuids (مصفوفة غير فارغة).

أمثلة الطلب

إزالة المستخدمين من جميع Journeys

{
  "user_ids": ["user1", "user2", "user3"],
  "all_journeys": true
}

إزالة المستخدمين من Journeys محددة

{
  "user_ids": ["user1", "user2"],
  "journey_uuids": ["journey-uuid-1", "journey-uuid-2"]
}

{
  "success": true
}

إذا كان الطلب غير صالح، ستتلقى خطأ 400 مع رسالة وصفية.

{
  "success": false,
  "message": "user_ids must be provided"
}

{
  "success": false,
  "message": "journey_uuids must be provided if all_journeys is false"
}