واجهة برمجة تطبيقات Customer Journey

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

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

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

قم بالمصادقة باستخدام رمز وصول API وأرسل طلبًا فارغًا إلى نقطة النهاية.

الترويسات

الاسم	النوع	الوصف
Authorization	string	معرف Journey

200: موافق

{
  "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 في عنوان URL لصفحة لوحة Journey:

قم بالمصادقة باستخدام رمز وصول API وأرسل طلبًا فارغًا إلى نقطة النهاية.

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
      }
    }]
  }
}

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

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

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

ترويسات الطلب

الترويسة	القيمة
Content-Type	`application/json`
Authorization	`Api <server_api_token>`. يجب تضمين رمز Server API صالح في ترويسة `Authorization`.

جسم الطلب

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

الحقل	النوع	مطلوب	الوصف
`user_ids`	`string[]`	نعم	قائمة معرفات المستخدمين لإزالتها من الرحلات.
`journey_uuids`	`string[]`	مطلوب إذا لم يتم توفير `all_journeys` أو كانت قيمته false.	قائمة بمعرفات UUID للرحلات التي سيتم إزالة المستخدمين منها.
`all_journeys`	`boolean`	مطلوب إذا لم يتم توفير `journey_uuids`.	إذا كانت القيمة true، فسيتم إزالة المستخدمين من جميع الرحلات. إذا كانت false، فيجب توفير `journey_uuids`.

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

أمثلة على الطلبات

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

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

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

{
  "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"
}