Customer Journey API

Journey के आँकड़े प्राप्त करें

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

इसकी ID द्वारा किसी विशिष्ट जर्नी के आँकड़े प्राप्त करता है। आप जर्नी कैनवास पेज के URL में जर्नी ID पा सकते हैं (नीचे चित्र देखें)।

API एक्सेस टोकन द्वारा अधिकृत करें और एंडपॉइंट पर एक खाली अनुरोध (request) भेजें।

हेडर्स (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
      }
    }]
  }
}

इसकी ID द्वारा किसी विशिष्ट जर्नी के आँकड़े प्राप्त करता है। आप जर्नी कैनवास पेज के URL में Journey ID पा सकते हैं:

API एक्सेस टोकन द्वारा अधिकृत करें और एंडपॉइंट पर एक खाली अनुरोध भेजें।

Request example

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

Response example

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

अनुरोध हेडर्स (Request headers)

Header	Value
Content-Type	application/json
Authorization	Bearer \<your_token\>. Authorization हेडर में एक वैध प्रमाणीकरण टोकन शामिल होना चाहिए।

अनुरोध बॉडी (Request body)

निम्नलिखित फ़ील्ड के साथ एक JSON ऑब्जेक्ट भेजें:

Field	Type	Required	Description
user_ids	string[]	हाँ (Yes)	जर्नी से हटाने के लिए User IDs की सूची।
journey_uuids	string[]	आवश्यक है यदि all_journeys प्रदान नहीं किया गया है या false है।	उपयोगकर्ताओं को हटाने के लिए जर्नी UUIDs की सूची।
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"]
}

प्रतिक्रिया उदाहरण

सफलता (200 OK)

{
  "success": true
}

त्रुटि (400 Bad Request)

यदि अनुरोध अमान्य है, तो आपको एक वर्णनात्मक संदेश के साथ 400 त्रुटि प्राप्त होगी।

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

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