Customer Journey API

জার্নি পরিসংখ্যান পান (Get Journey stats)

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

আইডি (ID) দ্বারা একটি নির্দিষ্ট জার্নির পরিসংখ্যান পায়। আপনি জার্নি ক্যানভাস পৃষ্ঠার URL-এ জার্নি আইডি খুঁজে পেতে পারেন (নিচের ছবিটি দেখুন)।

API অ্যাক্সেস টোকেন দ্বারা অনুমোদন করুন এবং এন্ডপয়েন্টে একটি খালি অনুরোধ পাঠান।

হেডার (Headers)

নাম	ধরন	বিবরণ
Authorization	string	জার্নি আইডি

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

আইডি দ্বারা একটি নির্দিষ্ট জার্নির পরিসংখ্যান পায়। আপনি জার্নি ক্যানভাস পৃষ্ঠার URL-এ জার্নি আইডি খুঁজে পেতে পারেন:

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

জার্নি থেকে ব্যবহারকারীদের সরান (Remove users from journeys)

এই এন্ডপয়েন্টটি আপনাকে সমস্ত বা নির্দিষ্ট সক্রিয় জার্নি থেকে ব্যবহারকারীদের একটি তালিকা সরাতে দেয়।

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

অনুরোধের হেডার (Request headers)

হেডার	মান
Content-Type	`application/json`
Authorization	`Bearer \<your_token\>`। `Authorization` হেডারে একটি বৈধ প্রমাণীকরণ টোকেন অন্তর্ভুক্ত করতে হবে।

অনুরোধের বডি (Request body)

নিম্নলিখিত ক্ষেত্রগুলির সাথে একটি 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"
}