Logo Site EngageLab Full Black
ติดต่อฝ่ายขาย

API สถิติ

info นี่คือเวอร์ชันล่าสุดของ Stats API การปรับปรุงในเวอร์ชัน v4 มีดังนี้:

  • ใช้การตรวจสอบสิทธิ์พื้นฐาน HTTP เพื่ออนุญาตการเข้าถึง ด้วยวิธีนี้ การร้องขอ API ทั้งหมดสามารถทำได้โดยใช้เครื่องมือ HTTP ทั่วไป เช่น curl และปลั๊กอินเบราว์เซอร์
  • เนื้อหาการ push เป็นรูปแบบ JSON

ภาพรวม

Stats API v4 มีฟังก์ชันการสืบค้นข้อมูลหลายรูปแบบ

การตรวจสอบการเรียกใช้

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ /th_TH/docs/web-push/rest-api/rest-api-overview#authentication-method

สถิติข้อความ

  • สอบถามสถิติของแต่ละสถานะในวงจรชีวิตของ message_id
  • สถิติของแต่ละข้อความ push สามารถเก็บไว้ได้สูงสุดหนึ่งเดือน

URL การร้องขอ API

GET v4/status/detail

ตัวอย่างการร้องขอ

curl -v https://webpushapi-sgp.engagelab.com/v4/status/detail?message_ids=1613113584,1229760629 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/status/detail?message_ids=1613113584,1229760629 HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
              
              curl -v https://webpushapi-sgp.engagelab.com/v4/status/detail?message_ids=1613113584,1229760629 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

< GET /v4/status/detail?message_ids=1613113584,1229760629 HTTP/1.1
< Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

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

พารามิเตอร์การร้องขอ

คีย์เวิร์ด ประเภท ตัวเลือก คำอธิบาย
message_ids String จำเป็น <li>รหัสข้อความ สามารถระบุหลาย message_ids โดยคั่นด้วย ","<li>สูงสุด 100 message_ids

ตัวอย่างการตอบกลับ

< HTTP/1.1 200 OK < Content-Type: application/json { "1083008": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 1, "clicks": 0, "sub": { "notification": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 1, "clicks": 0, "sub_web": { "engageLab_web": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "chrome": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 1, "clicks": 0 }, "safari": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "firefox": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "edge": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "other": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } } }, "message": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } }, "plan_id": "engageLab_msg", "pushContent": { "message": { "title": "msg", "content": "push" } } } }
              
              < HTTP/1.1 200 OK
< Content-Type: application/json
{
    "1083008": {
        "targets": 1,
        "sent": 1,
        "delivered": 1,
        "impressions": 1,
        "clicks": 0,
        "sub": {
            "notification": {
                "targets": 1,
                "sent": 1,
                "delivered": 1,
                "impressions": 1,
                "clicks": 0,
                "sub_web": {
                    "engageLab_web": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "chrome": {
                        "targets": 1,
                        "sent": 1,
                        "delivered": 1,
                        "impressions": 1,
                        "clicks": 0
                    },
                    "safari": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "firefox": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "edge": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "other": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    }
                }
            },
            "message": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            }
        },
        "plan_id": "engageLab_msg",
        "pushContent": {
            "message": {
                "title": "msg",
                "content": "push"
            }
        }
    }
}

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

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

การตอบกลับที่สำเร็จเป็นออบเจ็กต์ JSON โดยที่คีย์คือแต่ละ message_id และแต่ละข้อความต้องมีสถิติวงจรชีวิตของแต่ละขั้นตอน:

คีย์เวิร์ด ประเภท ตัวเลือก คำอธิบาย
targets Int64 จำเป็น เป้าหมายที่มีประสิทธิภาพ จำนวนอุปกรณ์เป้าหมายที่ถูกเลือกโดยงานหลังจากกรองประสิทธิภาพจะถูก push
sent Int64 จำเป็น จำนวนการส่ง ในบรรดาอุปกรณ์เป้าหมายที่มีประสิทธิภาพ เซิร์ฟเวอร์ Engagelab สร้างจำนวนอุปกรณ์ที่ส่งงานสำเร็จจริง
delivered Int64 จำเป็น จำนวนการจัดส่ง หลังจากส่งข้อความแจ้งเตือนแล้ว จำนวนการจัดส่งจริงไปยังปลายทางเว็บจะไม่รวมจำนวนการจัดส่งหลังจาก 5 วัน
impressions Int64 จำเป็น จำนวนการแสดงผล หลังจากจัดส่งข้อความแจ้งเตือนแล้ว จำนวนการแสดงผลที่สำเร็จจริงบนอุปกรณ์ปลายทางจะไม่ถูกนับ
clicks Int64 จำเป็น จำนวนการคลิก หลังจากแสดงข้อความแจ้งเตือนสำเร็จแล้ว จำนวนการคลิกจริงโดยผู้ใช้จะไม่ถูกนับ
sub Object จำเป็น ตัวบ่งชี้แยกย่อยของข้อมูลสถิติ <li>notification: สถิติสรุปข้อมูลของประเภทข้อความแจ้งเตือน <li>message: สถิติสรุปข้อมูลของข้อความที่กำหนดเองโดยผู้ใช้
plan_id String จำเป็น รหัสแผนการ push ซึ่งระบุประเภทแผนการ push ที่ข้อความนี้เป็นส่วนหนึ่ง
pushContent Object จำเป็น รายละเอียดเนื้อหาการ push รวมถึงข้อมูลเนื้อหาการ push สำหรับแพลตฟอร์มต่างๆ:
- android: เนื้อหาการ push สำหรับแพลตฟอร์ม Android (รวมถึงฟิลด์เช่น title และ content)
- ios: เนื้อหาการ push สำหรับแพลตฟอร์ม iOS (รวมถึงฟิลด์เช่น title, content และ subtitle)
- message: เนื้อหาข้อความที่กำหนดเอง (รวมถึงฟิลด์เช่น title และ content)
ตัวบ่งชี้
คีย์เวิร์ด ประเภท ตัวเลือก คำอธิบาย
sub_web Object ไม่จำเป็น สถิติสรุปข้อมูลของช่องทางการ push ต่างๆ ในช่องทางเว็บ
engageLab_web Object ไม่จำเป็น สถิติสรุปข้อมูลของช่องทาง Engagelab
chrome Object ไม่จำเป็น สถิติสรุปข้อมูลของช่องทาง Chrome
safari Object ไม่จำเป็น สถิติสรุปข้อมูลของช่องทาง Safari
firefox Object ไม่จำเป็น สถิติสรุปข้อมูลของช่องทาง Firefox
edge Object ไม่จำเป็น สถิติสรุปข้อมูลของช่องทาง Edge
other Object ไม่จำเป็น สถิติสรุปข้อมูลของช่องทางอื่นๆ

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

เรียกดูสถิติการพุชตาม ID แผนในช่วงวันที่ที่กำหนด รองรับหลายแผนและรายละเอียดตามประเภทข้อความและช่องทาง Web Push

ที่อยู่การเรียกใช้

GET /v4/status/plan/detail

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

GET /v4/status/plan/detail?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-07
              
              GET /v4/status/plan/detail?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-07

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

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

ชื่อพารามิเตอร์ ประเภท จำเป็นหรือไม่ คำอธิบาย
plan_ids string ใช่ รายการรหัสแผนการส่งข้อความ หลายรหัสคั่นด้วยเครื่องหมายจุลภาค รองรับสูงสุด 100 รหัส
start_date string ใช่ วันที่เริ่มต้นสถิติ (รูปแบบ: yyyy-MM-dd) ต้องเป็นไปตาม:
  • 1. วันที่สิ้นสุด >= วันที่เริ่มต้น
  • 2. ช่วงวันที่ ≤ 31 วัน
  • end_date string ใช่ วันที่สิ้นสุดสถิติ (รูปแบบ: yyyy-MM-dd)

    คำอธิบายพารามิเตอร์การตอบกลับ

    การตอบกลับสำเร็จ

    • วัตถุที่ส่งกลับจะเป็นโครงสร้างคีย์-ค่า ชื่อคีย์คือ plan_id ที่ร้องขอ
    • วัตถุแต่ละรายการที่เกี่ยวข้องกับ plan_id จะมีฟิลด์ดังต่อไปนี้:
    ชื่อพารามิเตอร์ ประเภท คำอธิบาย
    targets int64 จำนวนอุปกรณ์เป้าหมายที่มีประสิทธิภาพ (จำนวนรวมของอุปกรณ์ที่ไม่ซ้ำและผ่านการกรองความถูกต้อง)
    sent int64 จำนวนอุปกรณ์ที่สร้างงานการส่งข้อความจริง
    delivered int64 จำนวนอุปกรณ์ที่ส่งข้อความจริง (นับเฉพาะข้อมูลภายใน 5 วัน)
    impressions int64 จำนวนอุปกรณ์ที่แสดงข้อความ (นับเฉพาะข้อมูลภายใน 5 วัน)
    clicks int64 จำนวนครั้งที่ผู้ใช้คลิกข้อความ (นับเฉพาะข้อมูลภายใน 5 วัน)
    sub object สถิติที่แยกย่อยตามประเภทข้อความ (โครงสร้างดูในตาราง sub ด้านล่าง)

    โครงสร้างของ sub

    ประเภทข้อความ คำอธิบาย โครงสร้างย่อย
    notification สถิติการแจ้งเตือน มีข้อมูลรวมและสถิติช่องทาง Web ใน sub_web
    message สถิติข้อความที่กำหนดเอง มีเฉพาะข้อมูลรวม ไม่มี sub_web ตามโครงสร้างสถิติข้อความ WebPush ที่ใช้อยู่

    สถิติช่องทาง Web

    คีย์ช่องทางใน sub_web คำอธิบาย
    engageLab_web, chrome, safari, firefox, edge, other แต่ละช่องทางมี targets, sent, delivered, impressions และ clicks

    ตัวอย่างการตอบกลับ

    ตอบกลับสำเร็จ

    { "push_20231101": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 5, "sub": { "notification": { "targets": 80, "sent": 72, "delivered": 64, "impressions": 56, "clicks": 4, "sub_web": { "engageLab_web": { "targets": 30, "sent": 27, "delivered": 24, "impressions": 21, "clicks": 1 }, "chrome": { "targets": 30, "sent": 27, "delivered": 24, "impressions": 21, "clicks": 2 }, "safari": { "targets": 20, "sent": 18, "delivered": 16, "impressions": 14, "clicks": 1 }, "firefox": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "edge": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "other": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } } }, "message": { "targets": 20, "sent": 18, "delivered": 16, "impressions": 14, "clicks": 1 } } } }
                  
                  {
      "push_20231101": {
        "targets": 100,
        "sent": 90,
        "delivered": 80,
        "impressions": 70,
        "clicks": 5,
        "sub": {
          "notification": {
            "targets": 80,
            "sent": 72,
            "delivered": 64,
            "impressions": 56,
            "clicks": 4,
            "sub_web": {
              "engageLab_web": {
                "targets": 30,
                "sent": 27,
                "delivered": 24,
                "impressions": 21,
                "clicks": 1
              },
              "chrome": {
                "targets": 30,
                "sent": 27,
                "delivered": 24,
                "impressions": 21,
                "clicks": 2
              },
              "safari": {
                "targets": 20,
                "sent": 18,
                "delivered": 16,
                "impressions": 14,
                "clicks": 1
              },
              "firefox": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
              },
              "edge": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
              },
              "other": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
              }
            }
          },
          "message": {
            "targets": 20,
            "sent": 18,
            "delivered": 16,
            "impressions": 14,
            "clicks": 1
          }
        }
      }
    }
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    ตอบกลับไม่สำเร็จ

    { "error": { "code": 21003, "message": "Parameter value is invalid" } }
                  
                  {
      "error": {
        "code": 21003,
        "message": "Parameter value is invalid"
      }
    }
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    สถิติผู้ใช้

    • ให้ข้อมูลสถิติที่เกี่ยวข้องของผู้ใช้ในช่วงเวลาที่กำหนดในช่วง 2 เดือนที่ผ่านมา: รวมถึงผู้ใช้ใหม่ ผู้ใช้ออนไลน์ และผู้ใช้ที่ใช้งานอยู่
    • หน่วยเวลา: HOUR, DAY, MONTH

    URL การร้องขอ API

    GET v4/status/users

    ตัวอย่างการร้องขอ

    curl -v https://webpushapi-sgp.engagelab.com/v4/status/users?time_unit=DAY&start=2014-06-10&duration=3 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/status/users?time_unit=&start=&duration= HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
                  
                  curl -v https://webpushapi-sgp.engagelab.com/v4/status/users?time_unit=DAY&start=2014-06-10&duration=3 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"
    
    < GET /v4/status/users?time_unit=&start=&duration= HTTP/1.1
    < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    พารามิเตอร์การร้องขอ

    คีย์เวิร์ด ประเภท ตัวเลือก คำอธิบาย
    time_unit String ไม่จำเป็น หน่วยเวลา: <li>HOUR<li>DAY<li>MONTH
    start String ไม่จำเป็น เวลาเริ่มต้น <li>หากหน่วยเป็นชั่วโมง เวลาเริ่มต้นคือชั่วโมง (รวมวัน และควรเติม 0 หากน้อยกว่าสองหลัก) เช่น: 2006-01-02T15<li>หากหน่วยเป็นวัน เวลาเริ่มต้นคือวันที่ เช่น: 2022-06-11<li>หากหน่วยเป็นเดือน เวลาเริ่มต้นคือเดือน เช่น: 2022-06
    duration String ไม่จำเป็น ระยะเวลา <li>หากหน่วยเป็นวัน คือจำนวนวัน<li>สามารถสอบถามข้อมูลผู้ใช้ภายใน 60 วันเท่านั้น สำหรับ timeunit เป็น HOUR จะแสดงผลลัพธ์สถิติของวันปัจจุบันเท่านั้น

    ตัวอย่าง

    < HTTP/1.1 200 OK < Content-Type: application/json { "TimeUnit": "DAY", "start": "2014-06-10", "duration": 3, "items": [{ "time": "2014-06-12", "web": { "new": 1, "active": 1, "online": 2 } }] }
                  
                  < HTTP/1.1 200 OK
    < Content-Type: application/json
    {
        "TimeUnit": "DAY",
        "start": "2014-06-10",
        "duration": 3,
        "items": [{
            "time": "2014-06-12",
            "web": {
          "new": 1,
                "active": 1,
                "online": 2
        }
        }]
    }
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    พารามิเตอร์

    การตอบกลับที่สำเร็จเป็นออบเจ็กต์ JSON:

    คีย์เวิร์ด ประเภท ตัวเลือก คำอธิบาย
    TimeUnit String จำเป็น หน่วยเวลา มีสามค่า: <li>HOUR<li>DAY<li>MONTH
    start String จำเป็น เวลาเริ่มต้น <li>หากหน่วยเป็นชั่วโมง เวลาเริ่มต้นคือชั่วโมง (รวมวัน และควรเติม 0 หากน้อยกว่าสองหลัก) เช่น: 2022-06-11 09<li>หากหน่วยเป็นวัน เวลาเริ่มต้นคือวันที่ เช่น: 2022-06-11<li>หากหน่วยเป็นเดือน เวลาเริ่มต้นคือเดือน เช่น: 2022-06
    duration Integer จำเป็น ระยะเวลา <li>หากหน่วยเป็นวัน คือจำนวนวัน<li>สามารถสอบถามข้อมูลผู้ใช้ภายใน 60 วันเท่านั้น สำหรับ timeunit เป็น HOUR จะแสดงผลลัพธ์สถิติของวันปัจจุบันเท่านั้น
    items JSON Array จำเป็น ผลลัพธ์สถิติภายในช่วงเวลาที่กำหนดตามระยะเวลา
    • items:
      • web: สถิติสรุปข้อมูลของแพลตฟอร์มเว็บ
    คีย์เวิร์ด ประเภท ตัวเลือก คำอธิบาย
    new Int64 ไม่จำเป็น ผู้ใช้ใหม่
    online Int64 ไม่จำเป็น ผู้ใช้ออนไลน์
    active Int64 ไม่จำเป็น ผู้ใช้ที่ใช้งานอยู่

    สอบถามสถานะวงจรชีวิตข้อความ

    • สอบถามสถานะวงจรชีวิตข้อความของอุปกรณ์ที่สอดคล้องกับ message_id
    • สถิติของแต่ละข้อความ push สามารถเก็บไว้ได้สูงสุดหนึ่งเดือน

    URL การร้องขอ API

    GET v4/status/message

    ตัวอย่าง

    curl -v https://webpushapi-sgp.engagelab.com/v4/status/message?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/status/message?message_id=&registration_ids= HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
                  
                  curl -v https://webpushapi-sgp.engagelab.com/v4/status/message?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"
    
    < GET /v4/status/message?message_id=&registration_ids= HTTP/1.1
    < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    พารามิเตอร์

    คีย์เวิร์ด ประเภท ตัวเลือก คำอธิบาย
    message_id String จำเป็น รหัสข้อความ
    registration_ids String จำเป็น <li>รหัสลงทะเบียน สามารถระบุหลาย Registration IDs โดยคั่นด้วย ","<li>รองรับสูงสุด 1000 registration_ids

    ตัวอย่าง

    < HTTP/1.1 200 OK < Content-Type: application/json { "1507bfd3a7c568d4761": { "itime": 1762331775, "channel": "FCM", "status": "delivered" }, "17259fd3a7c568d4371": { "error_message": "The `registration_id` does not belong to the appkey", "error_code": 21003 }, "17259fd3a7c568d4787":{ "itime": 1762331775, "status": "sent_failed", "error_code": 401, "error_message": "token is invalid", "channel": "FCM" }, "17259fd3a7c568d4372": { "error_code": 21061, "error_message": "no effect status" } }
                  
                  < HTTP/1.1 200 OK
    < Content-Type: application/json
    {
        "1507bfd3a7c568d4761": {
            "itime": 1762331775,
            "channel": "FCM",
            "status": "delivered"
        },
        "17259fd3a7c568d4371": {
            "error_message": "The `registration_id` does not belong to the appkey",
            "error_code": 21003
        },
        "17259fd3a7c568d4787":{
            "itime": 1762331775,
            "status": "sent_failed",
            "error_code": 401,
            "error_message": "token is invalid",
            "channel": "FCM"		
        },
        "17259fd3a7c568d4372": {
            "error_code": 21061,
            "error_message": "no effect status"
        }
    }
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    การตอบกลับที่ล้มเหลว

    { "error": { "code": 21003, "message": "Parameter value is invalid" } }
                  
                  {
      "error": {
        "code": 21003,
        "message": "Parameter value is invalid"
      }
    }
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    พารามิเตอร์

    การตอบกลับที่สำเร็จเป็นออบเจ็กต์ JSON ที่มีสถานะปัจจุบันของแต่ละ registration_id ภายใต้ข้อความนี้ หากมีข้อมูลข้อผิดพลาดใด ๆ ข้อมูลจะรวมอยู่ใน error-message

    คีย์เวิร์ด ประเภท ตัวเลือก คำอธิบาย
    status String ไม่จำเป็น ช่วงของค่า: <li>plan: วัตถุประสงค์แผน<li>target_valid: วัตถุประสงค์ที่ถูกต้อง<li>target_invalid: วัตถุประสงค์ที่ไม่ถูกต้อง<li>sent: ส่งออก<li>sent_failed: ล้มเหลวในการส่ง<li>delivered: จัดส่ง<li>delivered_failed: การจัดส่งล้มเหลว<li>impression: การแสดงผล<li>click: การคลิก
    error_message String ไม่จำเป็น ข้อความแสดงข้อผิดพลาด

    การสืบค้นสถานะวงจรชีวิตของข้อความแบบแบตช์

    • สืบค้นแบบแบตช์สถานะวงจรชีวิตของข้อความสำหรับ registration_id เดียวภายใต้แต่ละ message_id หากมี registration_id หลายรายการภายใต้ message_id เดียวกัน จะส่งคืนรายการ message_id ดังกล่าวใน multi_regid_message_ids
    • ข้อมูลสถิติของข้อความแต่ละรายการจะถูกเก็บรักษาไว้ได้นานสูงสุดหนึ่งเดือน

    API Endpoint

    GET v4/status/batch/message

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

    curl -v https://webpushapi-sgp.engagelab.com/v4/status/batch/message?message_ids=1613113584,1613113585,1613113586 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/status/batch/message?message_ids=1613113584,1613113585,1613113586 HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
                  
                  curl -v https://webpushapi-sgp.engagelab.com/v4/status/batch/message?message_ids=1613113584,1613113585,1613113586 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"
    
    < GET /v4/status/batch/message?message_ids=1613113584,1613113585,1613113586 HTTP/1.1
    < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

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

    คำสำคัญ ประเภท ตัวเลือก คำอธิบาย
    message_ids String จำเป็น
  • รหัสข้อความ หากมีหลาย message_id ให้คั่นด้วย ","
  • รองรับสูงสุด 100 รายการ
  • คำอธิบายพารามิเตอร์การตอบกลับ

    การตอบกลับที่สำเร็จเป็น JSON Array Object; แต่ละรายการแสดงสถานะปัจจุบันภายใต้ message_id เดียว (และ registration_id เดียวแบบเลือกได้) หากมีข้อยกเว้นจะระบุไว้ใน error_message

    คำสำคัญ ประเภท ตัวเลือก ความหมาย
    message_id String Required ค่า message_id
    registration_id String Optional registration_id เดียวที่ถูกสอบถาม
    status String Optional ช่วงของค่า:
  • plan
  • target_valid
  • target_invalid
  • sent
  • sent_failed
  • delivered
  • delivered_failed
  • Impression
  • click
  • itime Int64 Optional เวลาการอัปเดตสถานะ ความแม่นยำถึงวินาที
    channel String Optional ข้อมูลเกี่ยวกับช่องทางที่ข้อความถูกส่งผ่าน
    error_message String Optional ข้อความแสดงข้อผิดพลาด
    error_code Int64 Optional รหัสสถานะข้อผิดพลาด

    ตัวอย่างการตอบกลับ

    การตอบกลับสำเร็จ

    < HTTP/1.1 200 OK < Content-Type: application/json [ { "message_id": "261585110", "error_message": "Multiple `registration_id` found under the same `message_id`.", "error_code": 21003 }, { "message_id": "261585123", "registration_id": "170976fa8ab73279b2f", "status": "click", "itime": 1766047747, "channel": "EngageLab" }, { "message_id": "1613113585", "error_message": "The `message_id` is invalid or does not exist.", "error_code": 21003 } ]
                  
                  < HTTP/1.1 200 OK
    < Content-Type: application/json
    [
      {
        "message_id": "261585110",
        "error_message": "Multiple `registration_id` found under the same `message_id`.",
        "error_code": 21003
      },
      {
        "message_id": "261585123",
        "registration_id": "170976fa8ab73279b2f",
        "status": "click",
        "itime": 1766047747,
        "channel": "EngageLab"
      },
      {
        "message_id": "1613113585",
        "error_message": "The `message_id` is invalid or does not exist.",
        "error_code": 21003
      }
    ]
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    การตอบกลับล้มเหลว

    { "error": { "code": 21003, "message": "Parameter value is invalid" } }
                  
                  {
      "error": {
        "code": 21003,
        "message": "Parameter value is invalid"
      }
    }
    
                
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    การตอบกลับการร้องขอ

    สถานะ HTTP

    อ้างอิง: /th_TH/docs/web-push/rest-api/http-status-code

    รหัสธุรกิจการตอบกลับ

    รหัส คำอธิบาย สถานะ HTTP
    0 สำเร็จ 200
    21001 Only support http POST request 405
    21003 ค่าพารามิเตอร์ไม่ถูกต้อง 400
    23001 การตรวจสอบสิทธิ์พื้นฐานล้มเหลว 401
    23002 พารามิเตอร์ขาดหายไป! 400
    23004 ค่า time_unit ไม่ตรงกับ start! 400
    23007 รองรับเฉพาะการสอบถาม message_id ภายใน 30 วัน! 400
    23100 ข้อผิดพลาดเซิร์ฟเวอร์ 400
    27000 เซิร์ฟเวอร์ตอบสนองช้า โปรดลองอีกครั้งในภายหลัง 500
    27201 msgid ไม่มีอยู่หรือไม่ใช่ของแอปพลิเคชันนี้ 400
    Icon Solid Transparent White Qiyu
    ติดต่อฝ่ายขาย