Customer Journey API

รับสถิติ Journey

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

รับสถิติสำหรับ Journey ที่ระบุโดยใช้ ID คุณสามารถค้นหา Journey ID ได้ใน URL ของหน้า Journey canvas (ดูรูปด้านล่าง)

อนุญาตสิทธิ์โดยใช้ API access token และส่ง request ว่างไปยัง endpoint

Headers

Name	Type	คำอธิบาย
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 canvas:

อนุญาตสิทธิ์โดยใช้ API access token และส่ง request ว่างไปยัง 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
      }
    }]
  }
}

ลบผู้ใช้ออกจาก Journey

Endpoint นี้ช่วยให้คุณสามารถลบรายชื่อผู้ใช้ออกจาก Journey ที่ใช้งานอยู่ทั้งหมดหรือเฉพาะบาง Journey ได้

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

Request headers

Header	Value
Content-Type	`application/json`
Authorization	`Bearer \<your_token\>`. ต้องระบุ authentication token ที่ถูกต้องใน header `Authorization`

Request body

ส่ง JSON object ที่มีฟิลด์ดังต่อไปนี้:

Field	Type	จำเป็น	คำอธิบาย
`user_ids`	`string[]`	ใช่	รายการ User IDs ที่จะลบออกจาก Journey
`journey_uuids`	`string[]`	จำเป็นหากไม่ได้ระบุ `all_journeys` หรือเป็น false	รายการ UUID ของ Journey ที่จะลบผู้ใช้ออก
`all_journeys`	`boolean`	จำเป็นหากไม่ได้ระบุ `journey_uuids`	หากเป็น true ผู้ใช้จะถูกลบออกจาก Journey ทั้งหมด หากเป็น false ต้องระบุ `journey_uuids`

หมายเหตุ: ต้องระบุอย่างน้อยหนึ่งรายการระหว่าง all_journeys (ตั้งค่าเป็น true) หรือ journey_uuids (array ที่ไม่ว่างเปล่า)

ตัวอย่าง Request

ลบผู้ใช้ออกจาก Journey ทั้งหมด

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

ลบผู้ใช้ออกจาก Journey ที่ระบุ

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

{
  "success": true
}

หาก request ไม่ถูกต้อง คุณจะได้รับ error 400 พร้อมข้อความอธิบาย

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

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