Statistics
อัพเดทล่าสุด :2023-03-14

Statistics

Statistics of delivery data (per day)

Email data counted by day

URL

https://email.api.engagelab.cc/v1/stats_day
          https://email.api.engagelab.cc/v1/stats_day

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

HTTP Request Method

GET
          GET

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

Request Headers

Header Type Required Description
Authorization String true Basic base64(apiUser:apiKey)

Query Parameter  Description

Parameter Type Required or not Description
time_zone string not time zone,example:+8
start_date string * start_date, formatted with yyyy-MM-dd
end_date string * end_date, formatted with yyyy-MM-dd
api_users string no obtain stats of specified API_USER; multiple API_USERs are separated by semicolons, for example,api_users=a;b;c`
label_ids string no obtain stats of specified label; multiple labels are separated by semicolons, for example,label_ids=a;b;c
domain_names string no obtain stats in specified domian; multiple domains are separated by semicolons, for example, domain_names=a;b;c`
aggregate_by boolean(1, 0) no defaults to 0; if aggregate=1, aggregated data will be returned

Tips: Time span cannot be longer than 3 months.

Request Example:

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

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

Returned value Description

Parameter Description
send_date send date
api_user API_USER
domain domain
label_id label ID
label_name label name
targets total targets,request numbers
sent total sent
delivered deliveries
invalid_email number of invalid email
soft_bounce soft_bounce
report_spam number of report spam
total_clicks total clicks
total_opens total opens
opens unique opens
clicks unique clicks
unsubscribe number of unsubscribe
delivered_percent percentage of deliveries
invalid_email_percent percentage of invalid emails
soft_bounce_percent percentage of soft bounce
report_spam_percent percentage of report spam
total_click_percent percentage of clicks
total_open_percent percentage of opens
open_percent percentage of unique opens
click_percent percentage of unique clicks
unsubscribe_percent percentage of unsubscribes

Returned value example:

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": 12001, "message": "Unauthorized." }
          {
    "code": 12001,
    "message": "Unauthorized."
}

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

Statistics of delivery data (per hour)

Email data counted by hour

URL

https://email.api.engagelab.cc/v1/stats_hour
          https://email.api.engagelab.cc/v1/stats_hour

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

HTTP Request Method

GET
          GET

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

Request Headers

Header Type Required Description
Authorization String true Basic base64(apiUser:apiKey)

Query Parameter  Description

Parameter Type Required or not Description
time_zone string no time zone,example:+8
send_date string yes send date, formatted with yyyy-MM-dd
api_users string no obtain stats of specified API_USER; multiple API_USERs are separated by semicolons, for example,api_users=a;b;c`
label_ids string no obtain stats in specified label; multiple labels are separated by semicolons, for example,label_ids=a;b;c`

Request Example:

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

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

Returned value Description

Parameter Description
send_date send date
send_hour an hour, within [0 – 23]
api_user API_USER
label_id label ID
targets total targets,request numbers
sent total sent
delivered deliveries
invalid_email number of invalid email
soft_bounce soft_bounce
report_spam number of report spam
total_clicks total clicks
total_opens total opens
opens unique opens
clicks unique clicks
unsubscribe number of unsubscribe
delivered_percent percentage of deliveries
invalid_email_percent percentage of invalid emails
soft_bounce_percent percentage of soft bounce
report_spam_percent percentage of report spam
total_click_percent percentage of clicks
total_open_percent percentage of opens
open_percent percentage of unique opens
click_percent percentage of unique clicks
unsubscribe_percent percentage of unsubscribes

Returned value example:

Response-success

HTTP Status: 200

{ "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 } ] }
          
{
    "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": 12001, "message": "Unauthorized." }
          {
    "code": 12001,
    "message": "Unauthorized."
}

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

Statistics of invalid email (per day)

Query classified stats of invalid email

URL

https://email.api.engagelab.cc/v1/stat_invalids
          https://email.api.engagelab.cc/v1/stat_invalids

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

HTTP Request Method

GET
          GET

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

Request Headers

Header Type Required Description
Authorization String true Basic base64(apiUser:apiKey)

Query Parameter  Description

Parameter Type Required or not Description
time_zone string no time zone,example:+8
start_date string no start_date, formatted with yyyy-MM-dd
end_date string no end_date, formatted with yyyy-MM-dd
api_users string no obtain stats of specified API_USER, mutiple API_USERs are separated by semicolons, for example, apiUserList=a;b;c
label_ids string no obtain stats of specified label; multiple labels are separated by semicolons, for example, labelIdList=a;b;c
domain_names string no obtain stats in specified domian; multiple domains are separated by semicolons, for example, domain_names=a;b;c`
aggregate_by int(1, 0) no defaults to 0; if aggregate=1, aggregated data will be returned

Tips:

  1. Whenaggregate=1,all data will be aggregated.
  2. When label_id_list and label_name_list are provided at the same time, the label_id_list is preferred for precise query; When only label_name_list is provided, fuzzy query is performed with all label_names in the list

Request Example:

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

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

Returned value Description

Parameter Description
send_date send date, formatted with yyyy-MM-dd
api_user API_USER
domain domain
label_id label ID
label_name label name
blacklists count of emails in Engagelab blacklist
unsubscribes count of emails in unsubscribe list
server_errors unavailable esp severs
format_errors invalid recipient addresses
ip_domain_rejecteds rejected IPs or domains
not_exists nonexistent recipients
spams count of spam emails
sender_recipient_rejecteds rejected senders or recipients
others others

Returned value example

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": 12001, "message": "Unauthorized." }
          {
    "code": 12001,
    "message": "Unauthorized."
}

        
โค้ดนี้โชว์เป็นหน้าต่างลอย
在文档中心打开