สถิติข้อมูล
ที่อยู่การโทร
| ศูนย์ข้อมูล | URL |
|---|---|
| สิงคโปร์ | https://email.api.engagelab.cc |
| ตุรกี | https://emailapi-tr.engagelab.com |
เมื่อใช้ REST API ให้แน่ใจว่าศูนย์ข้อมูลที่เลือกตรงกับ URL พื้นฐานที่เหมาะสม
POST/v1/stats_day
สถิติข้อมูลที่ส่ง (รายวัน)
สถิติข้อมูลอีเมลตามวัน
URL
https://email.api.engagelab.cc/v1/stats_day
https://email.api.engagelab.cc/v1/stats_day
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การค้นหา
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| time_zone | string | No | เขตเวลา ค่าเริ่มต้น: +8 |
| start_date | string | Yes | วันที่เริ่มต้น รูปแบบ: yyyy-MM-dd |
| end_date | string | Yes | วันที่สิ้นสุด รูปแบบ: yyyy-MM-dd |
| api_users | string | No | ดึงข้อมูลสถิติสำหรับ API_USER เฉพาะ แยก API_USER หลายตัวด้วย ; เช่น api_users=a;b;c |
| label_ids | string | No | ดึงข้อมูลสถิติภายใต้ป้ายกำกับเฉพาะ แยกป้ายกำกับหลายตัวด้วย ; เช่น label_ids=a;b;c |
| domain_names | string | No | ดึงข้อมูลสถิติสำหรับโดเมนที่รับเฉพาะ แยกโดเมนหลายตัวด้วย ; เช่น domain_names=a;b;c |
| aggregate_by | int | No | ค่าเริ่มต้นคือ 0 (ไม่มีการรวม) หากตั้งค่าเป็น 1 จะส่งคืนข้อมูลรวมสำหรับทุกมิติ |
หมายเหตุ:
ช่วงเวลาการค้นหาไม่ควรเกินสามเดือนปฏิทิน
ตัวอย่างการร้องขอ
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| send_date | วันที่ส่ง |
| api_user | API_USER |
| domain | โดเมนที่รับ |
| label_id | รหัสป้ายกำกับ |
| label_name | ชื่อป้ายกำกับ |
| targets | เป้าหมายทั้งหมด จำนวนคำร้องขอ |
| sent | จำนวนอีเมลที่ส่ง |
| delivered | จำนวนอีเมลที่ส่งถึง |
| invalid_email | จำนวนอีเมลที่ไม่ถูกต้อง |
| soft_bounce | จำนวนการตีกลับแบบนุ่มนวล |
| report_spam | จำนวนรายงานสแปม |
| total_clicks | จำนวนคลิกทั้งหมด |
| total_opens | จำนวนการเปิดทั้งหมด |
| opens | จำนวนการเปิด |
| clicks | จำนวนคลิก |
| unsubscribe | จำนวนการยกเลิกการสมัคร |
| delivered_percent | อัตราการส่งถึง |
| invalid_email_percent | อัตราอีเมลที่ไม่ถูกต้อง |
| soft_bounce_percent | อัตราการตีกลับแบบนุ่มนวล |
| report_spam_percent | อัตรารายงานสแปม |
| total_click_percent | อัตราคลิกทั้งหมด |
| total_open_percent | อัตราการเปิดทั้งหมด |
| open_percent | อัตราการเปิด |
| click_percent | อัตราคลิก |
| unsubscribe_percent | อัตราการยกเลิกการสมัคร |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"delivered": 0,
"sent":1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"opens_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
}
# ข้อมูลรวม aggregate_by = 1
{
"result": {
"targets": 146013,
"sent":13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"delivered": 0,
"sent":1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"opens_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
}
# ข้อมูลรวม aggregate_by = 1
{
"result": {
"targets": 146013,
"sent":13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
สถิติข้อมูลที่ส่ง (รายชั่วโมง)
สถิติข้อมูลอีเมลตามชั่วโมง
URL
https://email.api.engagelab.cc/v1/stats_hour
https://email.api.engagelab.cc/v1/stats_hour
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การค้นหา
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| time_zone | string | No | เขตเวลา ค่าเริ่มต้น: +8 |
| send_date | string | Yes | วันที่ส่งคำร้องขอ รูปแบบ: yyyy-MM-dd |
| api_users | string | No | ดึงข้อมูลสถิติสำหรับ API_USER เฉพาะ แยก API_USER หลายตัวด้วย ; เช่น api_users=a;b;c |
| label_ids | string | No | ดึงข้อมูลสถิติภายใต้ป้ายกำกับเฉพาะ แยกป้ายกำกับหลายตัวด้วย ; เช่น label_ids=a;b;c |
ตัวอย่างการร้องขอ
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>""
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>""
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| send_date | วันที่ส่ง |
| send_hour | ชั่วโมงเฉพาะ ช่วง [0-23] |
| api_user | API_USER |
| label_id | รหัสป้ายกำกับ |
| targets | เป้าหมายทั้งหมด จำนวนคำร้องขอ |
| sent | จำนวนอีเมลที่ส่ง |
| delivered | จำนวนอีเมลที่ส่งถึง |
| invalid_email | จำนวนอีเมลที่ไม่ถูกต้อง |
| soft_bounce | จำนวนการตีกลับแบบนุ่มนวล |
| report_spam | จำนวนรายงานสแปม |
| total_clicks | จำนวนคลิกทั้งหมด |
| total_opens | จำนวนการเปิดทั้งหมด |
| opens | จำนวนการเปิด |
| clicks | จำนวนคลิก |
| unsubscribe | จำนวนการยกเลิกการสมัคร |
| delivered_percent | อัตราการส่งถึง |
| invalid_email_percent | อัตราอีเมลที่ไม่ถูกต้อง |
| soft_bounce_percent | อัตราการตีกลับแบบนุ่มนวล |
| report_spam_percent | อัตรารายงานสแปม |
| total_click_percent | อัตราคลิกทั้งหมด |
| total_open_percent | อัตราการเปิดทั้งหมด |
| open_percent | อัตราการเปิด |
| click_percent | อัตราคลิก |
| unsubscribe_percent | อัตราการยกเลิกการสมัคร |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
# หาก sendHour ไม่ถูกส่งคืนสำหรับเวลาที่เฉพาะเจาะจง หมายความว่าไม่มีข้อมูลสำหรับชั่วโมงนั้น
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent":1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_emails": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent":1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
# หาก sendHour ไม่ถูกส่งคืนสำหรับเวลาที่เฉพาะเจาะจง หมายความว่าไม่มีข้อมูลสำหรับชั่วโมงนั้น
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent":1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_emails": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent":1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
สถิติอีเมลที่ไม่ถูกต้อง (รายวัน)
การค้นหาสถิติการจัดประเภทของอีเมลที่ไม่ถูกต้อง
URL
https://email.api.engagelab.cc/v1/stat_invalids
https://email.api.engagelab.cc/v1/stat_invalids
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การค้นหา
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| time_zone | string | No | เขตเวลา ค่าเริ่มต้น: +8 |
| start_date | string | Yes | วันที่เริ่มต้น รูปแบบ: yyyy-MM-dd |
| end_date | string | Yes | วันที่สิ้นสุด รูปแบบ: yyyy-MM-dd |
| api_users | string | No | ดึงข้อมูลสถิติสำหรับ API_USER เฉพาะ แยก API_USER หลายตัวด้วย ; เช่น api_users=a;b;c |
| label_ids | string | No | ดึงข้อมูลสถิติภายใต้ป้ายกำกับเฉพาะ แยกป้ายกำกับหลายตัวด้วย ; เช่น label_ids=a;b;c |
| domain_names | string | No | ดึงข้อมูลสถิติสำหรับโดเมนที่รับเฉพาะ แยกโดเมนหลายตัวด้วย ; เช่น domain_names=a;b;c |
| aggregate_by | int | No | ค่าเริ่มต้นคือ 0 (ไม่มีการรวม) หากตั้งค่าเป็น 1 จะส่งคืนข้อมูลรวมสำหรับทุกมิติ |
หมายเหตุ:
- ระยะเวลาการค้นหาไม่ควรเกินสามเดือน
- เมื่อ
aggregate_byถูกตั้งค่าเป็น 1 ข้อมูลสำหรับทุกมิติจะถูกรวมและสะสม
ตัวอย่างการร้องขอ
curl "https://email.api.engagelab.cc/v1/stats_invalid" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_invalid" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| send_date | วันที่ส่ง รูปแบบ: yyyy-MM-dd |
| api_user | API_USER |
| domain | โดเมนที่รับ |
| label_id | รหัสป้ายกำกับ |
| label_name | ชื่อป้ายกำกับ |
| blacklists | จำนวนในบัญชีดำ |
| unsubscribes | จำนวนในรายการยกเลิกการสมัคร |
| server_errors | จำนวนเซิร์ฟเวอร์ที่ไม่สามารถเข้าถึงได้ |
| format_errors | จำนวนข้อผิดพลาดรูปแบบผู้รับ |
| ip_domain_rejecteds | จำนวนการปฏิเสธ IP หรือโดเมน |
| not_exists | จำนวนผู้รับที่ไม่มีอยู่ |
| spams | จำนวนอีเมลสแปม |
| sender_recipient_rejecteds | จำนวนการปฏิเสธผู้ส่งหรือผู้รับ |
| others | อื่นๆ |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
# ข้อมูลรวม aggregate_by = 1
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
# ข้อมูลรวม aggregate_by = 1
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
