REST API สถิติการเดินทาง | Marketing Automation REST API ภาษาไทย

สอบถามข้อมูลสถิติ รวมถึง "สถิติสรุปการเดินทาง" "สถิติการส่งข้อความ" และ "สถิติการส่ง WebHook"

สถิติการเดินทาง

สอบถามข้อมูลการเดินทางสำหรับจำนวนการเข้า การแปลงเป้าหมาย การออกก่อนกำหนด การออกปกติ และจำนวนที่กำลังดำเนินการ

Endpoint

GET /v1/stats/journey

การรับรองความถูกต้อง

EngageLab REST API ใช้ HTTP Basic Authentication เพิ่มส่วนหัว Authorization ในคำขอ HTTP:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

โค้ดนี้โชว์เป็นหน้าต่างลอย

base64_auth_string สร้างโดย: base64(api_key:api_secret)

ชื่อส่วนหัวคือ "Authorization" และค่าเป็นคู่ "username:password" ที่เข้ารหัส base64 (มีเครื่องหมายทวิภาคคั่นระหว่างกลาง)
ในบริบทของ MA API username คือ APIKey และ password คือ APISecret รับ APIKey และ APISecret โดยการเพิ่มแหล่งข้อมูลประเภท API

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

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์คำขอ

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
journey_id	String	ใช่	รหัสการเดินทาง หลายรหัสคั่นด้วยเครื่องหมายจุลภาค สูงสุด 100 รายการ
time_unit	String	ใช่	หน่วยเวลา ค่า: HOUR, DAY
start_time	String	ใช่	เวลาเริ่มต้นในรูปแบบ `yyyy-MM-dd`
end_time	String	ใช่	เวลาสิ้นสุดในรูปแบบ `yyyy-MM-dd` เวลาสิ้นสุด >= เวลาเริ่มต้น ช่วงสูงสุด 31 วัน

พารามิเตอร์การตอบกลับ

ฟิลด์	ประเภท	คำอธิบาย
code	Integer	การเรียก API สำเร็จหรือไม่ 0 หมายถึงสำเร็จหรือสำเร็จบางส่วน ค่าอื่นๆ หมายถึงล้มเหลว
message	String	คำอธิบายผลลัพธ์การเรียก API `success` เมื่อสำเร็จ
data	Array<Object>	ข้อมูลสถิติที่ส่งกลับ
journey_id	Long	รหัสการเดินทาง
time_unit	String	หน่วยเวลา ค่า: HOUR, DAY
error_code	Int	การเรียกดูสถิติการเดินทางสำเร็จหรือไม่ 0 หมายถึงสำเร็จ ค่าอื่นๆ หมายถึงล้มเหลว
detail	Array<Object>	รายละเอียดรายชั่วโมง/รายวัน
time	String	วันที่สถิติในการตอบกลับ ในรูปแบบ `yyyy-MM-dd` หรือ `yyyy-MM-dd HH`
entry_count	Long	จำนวนการเข้า
conversion_count	Long	จำนวนการแปลง
completion_count	Long	จำนวนการออกปกติ
early_exit_count	Long	จำนวนการออกก่อนกำหนด
in_progress_count	Long	จำนวนที่กำลังดำเนินการ กล่าวคือ ยังอยู่ในการเดินทาง ณ เวลาสิ้นสุดหรือเวลาที่ระบุ

สำเร็จทั้งหมด

{ "code": 0, "message": "success", "data": [ { "journey_id":123, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }, { "journey_id":234, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }] }

              
              {  
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id":123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  },
  {
      "journey_id":234,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  }]
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

ล้มเหลวทั้งหมด

{ "code": 50219, "message": "The number of JourneyIDs exceeds 100." }

              
              {
  "code": 50219,
  "message": "The number of JourneyIDs exceeds 100."
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

สำเร็จบางส่วน

              
              {  
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  },
  {
      "journey_id": -1,
      "error_code": 50221
  }]
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

สถิติการส่งข้อความ

สอบถามข้อมูลการส่ง การจัดส่ง การคลิก และข้อมูลอื่นๆ สำหรับแต่ละคอมโพเนนต์ข้อความในการเดินทาง

Endpoint

GET /v1/stats/journey/message

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

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์คำขอ

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
journey_id	String	ใช่	รหัสการเดินทาง หลายรหัสคั่นด้วยเครื่องหมายจุลภาค สูงสุด 100 รายการ
time_unit	String	ใช่	หน่วยเวลา ค่า: HOUR, DAY
start_time	String	ใช่	เวลาเริ่มต้นในรูปแบบ `yyyy-MM-dd`
end_time	String	ใช่	เวลาสิ้นสุดในรูปแบบ `yyyy-MM-dd` เวลาสิ้นสุด >= เวลาเริ่มต้น ช่วงสูงสุด 31 วัน

พารามิเตอร์การตอบกลับ

ฟิลด์	ประเภท	คำอธิบาย
code	Integer	การเรียก API สำเร็จหรือไม่ 0 หมายถึงสำเร็จหรือสำเร็จบางส่วน ค่าอื่นๆ หมายถึงล้มเหลว
message	String	คำอธิบายผลลัพธ์การเรียก API `success` เมื่อสำเร็จ
data	Array<Object>	ข้อมูลสถิติที่ส่งกลับ
journey_id	Long	รหัสการเดินทาง
time_unit	String	หน่วยเวลา ค่า: HOUR, DAY
error_code	Int	การเรียกดูสถิติการเดินทางสำเร็จหรือไม่ 0 หมายถึงสำเร็จ ค่าอื่นๆ หมายถึงล้มเหลว
detail	Array<Object>	รายละเอียดรายชั่วโมง/รายวัน
time	String	วันที่สถิติในการตอบกลับ ในรูปแบบ `yyyy-MM-dd` หรือ `yyyy-MM-dd HH`
component_id	Long	รหัสคอมโพเนนต์ข้อความ
component_name	String	ชื่อคอมโพเนนต์ข้อความ เช่น `APP_PUSH_1`, `EMAIL_2`
channel	String	ประเภทช่องทาง
entry_count	Long	จำนวนการเข้า
plan_count	Long	จำนวนเป้าหมายที่วางแผน
send_count	Long	จำนวนที่ส่ง
delivery_count	Long	จำนวนที่จัดส่งสำเร็จ
impression_count	Long	จำนวนการแสดงผล
open_count	Long	จำนวนการเปิด
click_count	Long	จำนวนการคลิก
conversion_count	Long	จำนวนการแปลง
revenue_count	Long	จำนวนเหตุการณ์ที่สร้างรายได้
revenue_amount	Number	จำนวนรายได้ทั้งหมด

สำเร็จทั้งหมด

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "component_id": 8801, "component_name": "EMAIL_1", "channel": "Email", "time": "2026-05-28", "entry_count": 320, "plan_count": 312, "send_count": 290, "delivery_count": 270, "impression_count": 198, "open_count": 155, "click_count": 24, "conversion_count": 8, "revenue_count": 7, "revenue_amount": 488.50 }, { "component_id": 8801, "component_name": "EMAIL_1", "channel": "Email", "time": "2026-05-29", "entry_count": 305, "plan_count": 298, "send_count": 280, "delivery_count": 261, "impression_count": 185, "open_count": 144, "click_count": 19, "conversion_count": 6, "revenue_count": 5, "revenue_amount": 312.00 } ] } ] }

              
              {
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "component_id": 8801,
        "component_name": "EMAIL_1",
        "channel": "Email",
        "time": "2026-05-28",
        "entry_count": 320,
        "plan_count": 312,
        "send_count": 290,
        "delivery_count": 270,
        "impression_count": 198,
        "open_count": 155,
        "click_count": 24,
        "conversion_count": 8,
        "revenue_count": 7,
        "revenue_amount": 488.50
      },
      {
        "component_id": 8801,
        "component_name": "EMAIL_1",
        "channel": "Email",
        "time": "2026-05-29",
        "entry_count": 305,
        "plan_count": 298,
        "send_count": 280,
        "delivery_count": 261,
        "impression_count": 185,
        "open_count": 144,
        "click_count": 19,
        "conversion_count": 6,
        "revenue_count": 5,
        "revenue_amount": 312.00
      }
    ]
  }
]
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

สถิติการส่ง WebHook

สอบถามข้อมูลคำขอและความสำเร็จสำหรับแต่ละคอมโพเนนต์ WebHook ในการเดินทาง

Endpoint

GET /v1/stats/journey/webhook

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

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์คำขอ

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
journey_id	String	ใช่	รหัสการเดินทาง หลายรหัสคั่นด้วยเครื่องหมายจุลภาค สูงสุด 100 รายการ
time_unit	String	ใช่	หน่วยเวลา ค่า: HOUR, DAY
start_time	String	ใช่	เวลาเริ่มต้นในรูปแบบ `yyyy-MM-dd`
end_time	String	ใช่	เวลาสิ้นสุดในรูปแบบ `yyyy-MM-dd` เวลาสิ้นสุด >= เวลาเริ่มต้น ช่วงสูงสุด 31 วัน

พารามิเตอร์การตอบกลับ

ฟิลด์	ประเภท	คำอธิบาย
code	Integer	การเรียก API สำเร็จหรือไม่ 0 หมายถึงสำเร็จหรือสำเร็จบางส่วน ค่าอื่นๆ หมายถึงล้มเหลว
message	String	คำอธิบายผลลัพธ์การเรียก API `success` เมื่อสำเร็จ
data	Array<Object>	ข้อมูลสถิติที่ส่งกลับ
journey_id	Long	รหัสการเดินทาง
time_unit	String	หน่วยเวลา ค่า: HOUR, DAY
error_code	Int	การเรียกดูสถิติการเดินทางสำเร็จหรือไม่ 0 หมายถึงสำเร็จ ค่าอื่นๆ หมายถึงล้มเหลว
detail	Array<Object>	รายละเอียดรายชั่วโมง/รายวัน
time	String	วันที่สถิติในการตอบกลับ ในรูปแบบ `yyyy-MM-dd` หรือ `yyyy-MM-dd HH`
component_id	Long	รหัสคอมโพเนนต์ข้อความ
component_name	String	ชื่อคอมโพเนนต์ข้อความ เช่น `APP_PUSH_1`, `EMAIL_2`
entry_count	Long	จำนวนการเข้าสู่คอมโพเนนต์ Webhook
send_count	Long	จำนวนคำขอที่สำเร็จ
send_failure_count	Long	จำนวนคำขอที่ล้มเหลว

สำเร็จทั้งหมด

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "component_id": 9001, "component_name": "WEBHOOK_1", "time": "2026-05-28", "entry_count": 520, "send_count": 498, "send_failure_count": 22 }, { "component_id": 9001, "component_name": "WEBHOOK_1", "time": "2026-05-29", "entry_count": 610, "send_count": 600, "send_failure_count": 10 } ] } ] }

              
              {
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "component_id": 9001,
        "component_name": "WEBHOOK_1",
        "time": "2026-05-28",
        "entry_count": 520,
        "send_count": 498,
        "send_failure_count": 22
      },
      {
        "component_id": 9001,
        "component_name": "WEBHOOK_1",
        "time": "2026-05-29",
        "entry_count": 610,
        "send_count": 600,
        "send_failure_count": 10
      }
    ]
  }
]
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

รหัสข้อผิดพลาด

รหัสข้อผิดพลาดทั่วไป

HTTP Status	code	message	คำอธิบาย
401	40050	authorization invalid	การรับรองความถูกต้องล้มเหลว
429	55110	Too many requests, please try again later.	เกินขีดจำกัดอัตราการเรียก
400	40001	http参数不合法	ข้อความ HTTP ไม่ถูกต้องหรือพารามิเตอร์ path/query ที่จำเป็น
400	40002	业务参数不合法	การตรวจสอบรูปแบบ ENUM หรือประเภทของพารามิเตอร์ล้มเหลว
400	50034	项目不存在	โครงการที่ผูกกับ APIKey ไม่มีอยู่
500	-1	服务器内部错误	ข้อผิดพลาดภายในเซิร์ฟเวอร์

รหัสข้อผิดพลาดของสถิติการเดินทาง

HTTP Status	code	message	คำอธิบาย
400	50202	Journey does not exist.	การเดินทางไม่มีอยู่หรือไม่ได้อยู่ในโครงการปัจจุบัน
400	50217	Invalid time range.	`start_time > end_time` หรือช่วงการสอบถามเกิน 31 วัน
400	50219	The number of JourneyIDs exceeds 100.	จำนวน JourneyID เกินขีดจำกัด 100 รายการ
400	50220	Invalid time_unit.	ค่า time_unit ไม่ถูกต้อง รองรับเฉพาะ HOUR และ DAY
400	50221	Invalid journey_id format.	รูปแบบ JourneyID เดี่ยวไม่ถูกต้อง (ฟิลด์ error_code ระบุว่าการสอบถามการเดินทางเฉพาะรายการล้มเหลว)