Customer Journey API

รับสถิติ Journey

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

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

ให้สิทธิ์โดยใช้ API access token และส่งคำขอที่ว่างเปล่าไปยัง endpoint

ส่วนหัว (Headers)

ชื่อ	ประเภท	คำอธิบาย
Authorization	string	Journey ID

200: OK

{
  "payload": {
    "title": "ชื่อ Journey",
    "points": [{
      "pointTitle": "ชื่อจุดแรก",
      "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 และส่งคำขอที่ว่างเปล่าไปยัง endpoint

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

{
  "payload": {
    "title": "ชื่อ Journey",
    "points": [{
      "pointTitle": "ชื่อจุดแรก",
      "campaignCode": "AAAAA-00000",
      "presetCode": "12345-67890",
      "pointStat": {
        "sent": 22648,
        "opened": 60,
        "uniqOpened": 60,
        "conversion": 0.26492405510420347
      }
    }]
  }
}

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

endpoint นี้ช่วยให้คุณสามารถลบรายชื่อผู้ใช้ออกจาก journeys ที่ใช้งานอยู่ทั้งหมดหรือบางส่วนได้

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

ส่วนหัวของคำขอ (Request headers)

ส่วนหัว	ค่า
Content-Type	`application/json`
Authorization	`Api <server_api_token>` ต้องมี Server API token ที่ถูกต้องรวมอยู่ในส่วนหัว `Authorization`

เนื้อหาของคำขอ (Request body)

ส่งอ็อบเจกต์ JSON ที่มีฟิลด์ต่อไปนี้:

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

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

ตัวอย่างคำขอ

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

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

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

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