कस्टमर जर्नी API

जर्नी के आँकड़े प्राप्त करें

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

यह अपनी आईडी द्वारा एक विशिष्ट जर्नी के लिए आँकड़े प्राप्त करता है। आप जर्नी आईडी को जर्नी कैनवास पेज के URL में पा सकते हैं (नीचे दी गई तस्वीर देखें)।

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

हेडर

नाम	प्रकार	विवरण
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 में पा सकते हैं:

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>`. एक मान्य सर्वर API टोकन को `Authorization` हेडर में शामिल किया जाना चाहिए।

अनुरोध बॉडी

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

फ़ील्ड	प्रकार	आवश्यक	विवरण
`user_ids`	`string[]`	हाँ	जर्नी से हटाने के लिए यूज़र आईडी की सूची।
`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"]
}

{
  "success": true
}

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

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

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