logoเอกสาร
AppPush
หน้าหลักเอกสาร
คู่มือผู้ใช้คู่มือนักพัฒนาข้อมูลและความเป็นส่วนตัวแนวทางปฏิบัติที่ดีที่สุด
ค้นหา
ภาษาไทย
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
เข้าสู่ระบบ
คู่มือนักพัฒนา / REST API / สถิติ API

สถิติ API

อัพเดทล่าสุด ：2025-07-22

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

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

ภาพรวม

Stats API v4 ให้ฟังก์ชันการสืบค้นข้อมูลสถิติต่างๆ

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

ดูรายละเอียดในภาพรวม REST API วิธีการรับรองความถูกต้อง

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

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

ที่อยู่ API

GET v4/status/detail

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

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

< GET /v4/messages/details?message_ids=1613113584,1229760629 HTTP/1.1
< Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
โค้ดนี้โชว์เป็นหน้าต่างลอย

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

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

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

    < HTTP/1.1 200 OK < Content-Type: application/json { "1229760629": { "targets": 11, "sent": 11, "delivered": 10, "impressions": 8, "clicks": 2, "sub": { "notification": {}, "message": {}, "live_activity": {}, "voip": {}, "inapp_message": {} }, "plan_id": "", "pushContent": {} }, "1613113584": { "targets": 11, "sent": 11, "delivered": 10, "impressions": 8, "clicks": 2, "sub": { "notification": { "target": 1600, "sent": 1440, "delivered": 1280, "impressions": 1120, "click": 0, "sub_android": { "engageLab_android": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "huawei": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "xiaomi": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "oppo": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "vivo": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "meizu": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "fcm": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "honor": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 } }, "sub_ios": { "engageLab_ios": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "apns": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 } } }, "message": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0, "sub_android": {}, "sub_ios": {} }, "live_activity": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 0, "clicks": 0, "sub_ios": { "engageLab_ios": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "apns": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 0, "clicks": 0 } } } }, "plan_id": "engageLab_notification", "pushContent": { "android": { "title": "push", "content": "hello, Push!" }, "ios": { "title": "ios", "content": "pushContent", "subtitle": "engageLab_push" } } }, "1613113554": { "targets": 2, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0, "sub": { "notification": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "message": { "targets": 2, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0, "sub_android": { "engageLab_android": { "targets": 1, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "huawei": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "xiaomi": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "oppo": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "vivo": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "meizu": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "fcm": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "honor": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } }, "sub_ios": { "engageLab_ios": { "targets": 1, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "apns": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } } }, "live_activity": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "voip": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "inapp_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

{
    "1229760629": {
        "targets": 11,
        "sent": 11,
        "delivered": 10,
        "impressions": 8,
        "clicks": 2,
        "sub": {
            "notification": {},
            "message": {},
            "live_activity": {},
            "voip": {},
            "inapp_message": {}
        },
        "plan_id": "",
        "pushContent": {}
    },
    "1613113584": {
        "targets": 11,
        "sent": 11,
        "delivered": 10,
        "impressions": 8,
        "clicks": 2,
        "sub": {
            "notification": {
                "target": 1600,
                "sent": 1440,
                "delivered": 1280,
                "impressions": 1120,
                "click": 0,
                "sub_android": {
                    "engageLab_android": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "huawei": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "xiaomi": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "oppo": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "vivo": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "meizu": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "fcm": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "honor": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    }
                },
                "sub_ios": {
                    "engageLab_ios": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "apns": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    }
                }
            },
            "message": {
                "targets": 100,
                "sent": 90,
                "delivered": 80,
                "impressions": 70,
                "clicks": 0,
                "sub_android": {},
                "sub_ios": {}
            },
            "live_activity": {
                "targets": 1,
                "sent": 1,
                "delivered": 1,
                "impressions": 0,
                "clicks": 0,
                "sub_ios": {
                    "engageLab_ios": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "apns": {
                        "targets": 1,
                        "sent": 1,
                        "delivered": 1,
                        "impressions": 0,
                        "clicks": 0
                    }
                }
            }
        },
        "plan_id": "engageLab_notification",
        "pushContent": {
            "android": {
                "title": "push",
                "content": "hello, Push!"
            },
            "ios": {
                "title": "ios",
                "content": "pushContent",
                "subtitle": "engageLab_push"
            }
        }
    },
    "1613113554": {
        "targets": 2,
        "sent": 0,
        "delivered": 0,
        "impressions": 0,
        "clicks": 0,
        "sub": {
            "notification": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            },
            "message": {
                "targets": 2,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0,
                "sub_android": {
                    "engageLab_android": {
                        "targets": 1,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "huawei": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "xiaomi": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "oppo": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "vivo": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "meizu": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "fcm": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "honor": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    }
                },
                "sub_ios": {
                    "engageLab_ios": {
                        "targets": 1,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "apns": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    }
                }
            },
            "live_activity": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            },
            "voip": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            },
            "inapp_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 จำเป็น เป้าหมายที่มีประสิทธิภาพ จำนวนอุปกรณ์เป้าหมายหลังจากกรองความถูกต้องเมื่อเลือกกลุ่มเป้าหมายสำหรับงานการส่งข้อความ
    sent Int64 จำเป็น จำนวนที่ส่ง จำนวนอุปกรณ์ที่เซิร์ฟเวอร์ Engagelab สร้างงานการส่งข้อความสำเร็จ
    delivered Int64 จำเป็น จำนวนที่ส่งถึง จำนวนอุปกรณ์ที่ได้รับข้อความแจ้งเตือนจริง ข้อมูลที่ส่งหลังจาก 5 วันจะไม่นับรวมในสถิติ สำหรับ Huawei, Meizu และ iOS ต้องตั้งค่าการเรียกกลับเพื่อรับข้อมูลที่แม่นยำยิ่งขึ้น
    impressions Int64 จำเป็น จำนวนการแสดงผล จำนวนอุปกรณ์ที่แสดงข้อความแจ้งเตือนสำเร็จ ข้อมูลที่แสดงหลังจาก 5 วันจะไม่นับรวมในสถิติ
    clicks Int64 จำเป็น จำนวนการคลิก จำนวนครั้งที่ผู้ใช้คลิกข้อความแจ้งเตือนหลังจากแสดงสำเร็จ ข้อมูลที่คลิกหลังจาก 5 วันจะไม่นับรวมในสถิติ
    sub Object จำเป็น ตัวชี้วัดรายละเอียดของสถิติ ดูตารางด้านล่าง
  • notification: สถิติรวมของข้อความประเภทการแจ้งเตือน
  • message: สถิติรวมของข้อความที่กำหนดเอง
  • live_activity: สถิติรวมของข้อความกิจกรรมสด
  • voip: สถิติรวมของข้อความ voip
    		•
    plan_id String จำเป็น รหัสแผนการส่งข้อความที่ระบุประเภทแผนการส่งข้อความที่ข้อความเป็นของ
    pushContent Object จำเป็น รายละเอียดเนื้อหาการส่งข้อความ รวมถึงข้อมูลเนื้อหาการส่งข้อความสำหรับแพลตฟอร์มต่างๆ:
    - android: เนื้อหาการส่งข้อความสำหรับแพลตฟอร์ม Android (รวมถึงฟิลด์ชื่อเรื่อง เนื้อหา ฯลฯ)
    - ios: เนื้อหาการส่งข้อความสำหรับแพลตฟอร์ม iOS (รวมถึงฟิลด์ชื่อเรื่อง เนื้อหา ชื่อเรื่องย่อย ฯลฯ)
    - message: เนื้อหาข้อความที่กำหนดเอง (รวมถึงฟิลด์ชื่อเรื่อง เนื้อหา ฯลฯ)
    ตัวชี้วัด
    คำสำคัญ ประเภท ตัวเลือก คำอธิบาย
    sub_android Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทางการส่งข้อความ Android
    engageLab_android Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง Engagelab Android
    huawei Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง Huawei
    honor Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง Honor
    xiaomi Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง Xiaomi
    oppo Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง OPPO
    vivo Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง vivo
    meizu Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง Meizu
    fcm Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง FCM
    sub_ios Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทางการส่งข้อความ iOS
    engageLab_ios Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง Engagelab iOS
    apns Object ตัวเลือก สถิติและข้อมูลสรุปของช่องทาง APNs iOS

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

    • อินเทอร์เฟซนี้ใช้สำหรับรับตัวชี้วัดสถิติรายละเอียดของแผนการส่งข้อความ รองรับการค้นหาข้อมูลแบบกลุ่มในช่วงเวลาที่ระบุสำหรับแผนหลายแผน รวมถึงตัวชี้วัดที่แยกย่อยในหลายมิติ (แพลตฟอร์ม/ผู้ผลิต/ประเภทข้อความ)

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

    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 สถิติข้อความการแจ้งเตือน รวมถึง sub_android (สถิติผู้ผลิต Android) / sub_ios (สถิติ iOS)
      message สถิติข้อความที่กำหนดเอง รวมถึง sub_android / sub_ios
      live_activity สถิติข้อความกิจกรรมสด รวมถึงเฉพาะ sub_ios
      voip สถิติข้อความ VOIP รวมถึงเฉพาะ sub_ios

    • ฟิลด์สถิติผู้ผลิตแพลตฟอร์ม

      ชื่อพารามิเตอร์ ประเภท คำอธิบาย
      targets int64 จำนวนอุปกรณ์เป้าหมายที่มีประสิทธิภาพสำหรับผู้ผลิตที่เกี่ยวข้อง
      sent int64 จำนวนที่ส่งข้อความจริงผ่านช่องทางผู้ผลิต
      delivered int64 จำนวนที่ส่งข้อความจริงผ่านช่องทางผู้ผลิต
      impressions int64 จำนวนที่แสดงข้อความผ่านช่องทางผู้ผลิต
      clicks int64 จำนวนที่คลิกข้อความผ่านช่องทางผู้ผลิต

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

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

    { "push_20231101": { "targets": 1500, "sent": 1450, "delivered": 1400, "impressions": 1350, "clicks": 120, "sub": { "notification": { "sub_android": { "huawei": { "targets":200, "sent":190, "delivered":185, "impressions":180, "clicks":15 }, "xiaomi": { "targets":180, "sent":175, "delivered":170, "impressions":165, "clicks":10 } }, "sub_ios": { "apns": { "targets":300, "sent":295, "delivered":290, "impressions":285, "clicks":25 } } }, "live_activity": { "sub_ios": { "apns": { "targets":50, "sent":48, "delivered":45, "impressions":40, "clicks":5 } } } } } }
                  
              {
  "push_20231101": {
    "targets": 1500,
    "sent": 1450,
    "delivered": 1400,
    "impressions": 1350,
    "clicks": 120,
    "sub": {
      "notification": {
        "sub_android": {
          "huawei": { "targets":200, "sent":190, "delivered":185, "impressions":180, "clicks":15 },
          "xiaomi": { "targets":180, "sent":175, "delivered":170, "impressions":165, "clicks":10 }
        },
        "sub_ios": {
          "apns": { "targets":300, "sent":295, "delivered":290, "impressions":285, "clicks":25 }
        }
      },
      "live_activity": {
        "sub_ios": {
          "apns": { "targets":50, "sent":48, "delivered":45, "impressions":40, "clicks":5 }
        }
      }
    }
  }
}
    โค้ดนี้โชว์เป็นหน้าต่างลอย

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

    { "error": { "code": 21003, "message": "ค่าพารามิเตอร์ไม่ถูกต้อง" } }
                  
              {
  "error": {
    "code": 21003,
    "message": "ค่าพารามิเตอร์ไม่ถูกต้อง"
  }
}
    โค้ดนี้โชว์เป็นหน้าต่างลอย

    สถิติผู้ใช้

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

    ที่อยู่ API คำขอ

    GET v4/status/users

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

    curl -v https://pushapi-sgp.engagelab.com/v4/status/users?time_unit=DAY&start=2014-06-10&duration=3 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/users?time_unit=DAY&start=2014-06-10&duration=3 HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
                  
              curl -v https://pushapi-sgp.engagelab.com/v4/status/users?time_unit=DAY&start=2014-06-10&duration=3 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

< GET /v4/users?time_unit=DAY&start=2014-06-10&duration=3 HTTP/1.1
< Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
    โค้ดนี้โชว์เป็นหน้าต่างลอย

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

    คำสำคัญ ประเภท ตัวเลือก คำอธิบาย
    time_unit String required หน่วยเวลา：
  • HOUR
  • DAY
  • MONTH
    		•
    start String required เวลาเริ่มต้น
  • หากหน่วยเป็นชั่วโมง เวลาเริ่มต้นคือชั่วโมง (รวมถึงวัน และต้องเติม 0 หากน้อยกว่าสองหลัก) ตัวอย่างรูปแบบ: 2022-06-11 09
  • หากหน่วยเป็นวัน เวลาเริ่มต้นคือวันที่ (วัน) ตัวอย่างรูปแบบ: 2022-06-11
  • หากหน่วยเป็นเดือน เวลาเริ่มต้นคือวันที่ (เดือน) ตัวอย่างรูปแบบ: 2022-06
    		•
    duration String required ระยะเวลา
  • หากหน่วยเป็นวัน คือจำนวนวันต่อเนื่อง และอื่นๆ
  • สามารถค้นหาข้อมูลผู้ใช้ได้เฉพาะภายใน 60 วัน หากหน่วยเวลาเป็น HOUR สามารถแสดงผลลัพธ์ทางสถิติของวันปัจจุบันได้เท่านั้น
    		•

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

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

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

    การตอบกลับสำเร็จเป็น JSON Object：

    คำสำคัญ ประเภท ตัวเลือก คำอธิบาย
    time_unit String required หน่วยเวลา
  • HOUR
  • DAY
  • MONTH
    		•
    start String required เวลาเริ่มต้น
  • หากหน่วยเป็นชั่วโมง เวลาเริ่มต้นคือชั่วโมง (รวมถึงวัน และต้องเติม 0 หากน้อยกว่าสองหลัก) ตัวอย่างรูปแบบ: 2022-06-11 09
  • หากหน่วยเป็นวัน เวลาเริ่มต้นคือวันที่ (วัน) ตัวอย่างรูปแบบ: 2022-06-11
  • หากหน่วยเป็นเดือน เวลาเริ่มต้นคือวันที่ (เดือน) ตัวอย่างรูปแบบ: 2022-06
    		•
    duration String required ระยะเวลา
  • หากหน่วยเป็นวัน คือจำนวนวันต่อเนื่อง และอื่นๆ
  • สามารถค้นหาข้อมูลผู้ใช้ได้เฉพาะภายใน 60 วัน หากหน่วยเวลาเป็น HOUR สามารถแสดงผลลัพธ์ทางสถิติของวันปัจจุบันได้เท่านั้น
    		•
    items JSON Array required ผลลัพธ์ทางสถิติภายในช่วงการค้นหาตามระยะเวลา
    • คำอธิบายฟิลด์ items：
      • android：สรุปข้อมูลสถิติของแพลตฟอร์ม Android
      • ios：สรุปข้อมูลและสถิติของแพลตฟอร์ม Apple
    คำสำคัญ ประเภท ตัวเลือก คำอธิบาย
    new Int64 optional ผู้ใช้ใหม่
    active Int64 optional ผู้ใช้ที่ใช้งานอยู่

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

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

    URL คำขอ API

    GET v4/status/message

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

    curl -v https://pushapi-sgp.engagelab.com/v4/status/message?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/status?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
                  
              curl -v https://pushapi-sgp.engagelab.com/v4/status/message?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

< GET /v4/status?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 HTTP/1.1
< Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
    โค้ดนี้โชว์เป็นหน้าต่างลอย

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

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

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

    < HTTP/1.1 200 OK < Content-Type: application/json { "1507bfd3a7c568d4761": { "status": "plan" }, "1618cfd3a7c568d4761": { "error_message": "The `registration_id` does not belong to the appkey" }, "17259fd3a7c568d4371": { "error_message": "internal error" }, "17259fd3a7c568d4xxx":{ "error_message": "regid illegal" } }
                  
              < HTTP/1.1 200 OK
< Content-Type: application/json
{
    "1507bfd3a7c568d4761": {
        "status": "plan"
    },
    "1618cfd3a7c568d4761": {
        "error_message": "The  `registration_id` does not belong to the appkey"
    },
    "17259fd3a7c568d4371": {
        "error_message": "internal error"
    },
    "17259fd3a7c568d4xxx":{
        "error_message": "regid illegal"  
    }
}
    โค้ดนี้โชว์เป็นหน้าต่างลอย

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

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

    คำสำคัญ ประเภท ตัวเลือก คำอธิบาย
    status String optional ช่วงค่าที่เป็นไปได้：
  • plan：เป้าหมายที่วางแผนไว้
  • target_valid：เป้าหมายที่ถูกต้อง
  • target_invalid：เป้าหมายที่ไม่ถูกต้อง
  • sent：ส่งแล้ว
  • sent_failed：การส่งล้มเหลว
  • delivered：ส่งสำเร็จ
  • delivered_failed：การส่งล้มเหลว
  • Impression：แสดงผล
  • click：คลิก
    		•
    error_message String optional ข้อความแสดงข้อผิดพลาด

    รหัสการตอบกลับ

    รหัสสถานะ HTTP

    เอกสารอ้างอิง：HTTP-Status-Code

    รหัสการคืนค่า

    รหัส คำอธิบาย คำอธิบายรายละเอียด รหัสสถานะ HTTP
    0 success คำขอสำเร็จ 200
    21001 The method is not supported or url err ข้อผิดพลาดในวิธีการคำขอ (GET/POST) หรือข้อผิดพลาดใน URL (อินเทอร์เฟซไม่มีอยู่) 404
    21003 Parameter value is invalid ค่าพารามิเตอร์ไม่ถูกต้อง 400
    23001 Basic authentication failed การรับรองความถูกต้อง HTTP Basic ล้มเหลว 401
    23002 Missing parameter! ขาดพารามิเตอร์ที่จำเป็น! 400
    23004 time_unit value does not match with start! ค่าพารามิเตอร์ time_unit และ start ไม่ตรงกัน 400
    23007 Only support quering the message_id within 30 days! สามารถค้นหาข้อความได้เฉพาะภายใน 30 วัน 400
    23100 server error ข้อผิดพลาดภายในระบบ 500
    27000 Server response time out, please try again later ข้อผิดพลาดภายในระบบ 500
    27201 msgid not exist or not belong this app msgid ไม่มีอยู่หรือไม่เป็นของแอปนี้ 400
    icon
    ติดต่อฝ่ายขาย