SendCloud

# 数据统计

# 发送数据统计 (每天)

按天统计的邮件数据

URL

https://api2.sendcloud.net/api/statday/list
1

HTTP请求方式

post    get
1

参数说明

参数 类型 必须 说明
apiUser string 是 API_USER
apiKey string 是 API_KEY
days int * 过去 days 天内的统计数据 (days=1表示今天)
startDate string * 开始日期, 格式为yyyy-MM-dd
endDate string * 结束日期, 格式为yyyy-MM-dd
apiUserList string 否 获取指定 API_USER 的统计数据, 多个 API_USER 用;分开, 如:apiUserList=a;b;c
labelIdList string 否 获取指定标签下的统计数据, 多个标签用;分开, 如:labelIdList=a;b;c
labelNameList string 否 获取指定标签名下的统计数据, 多个标签用;分开(中文名称以UTF-8编码), 如:labelIdList=a;b;c
domainList string 否 获取指定收信域名下的统计数据, 多个域名用;分开, 如:domainList=a;b;c
aggregate boolean(1, 0) 否 默认为0. 如果为1, 则返回聚合数据

提示:

  1. 获取统计数据时, 必须指定时间区间. 即 startDate 与 endDate 的组合 或者 days 参数 需二者取一.
  2. 查询的天数不超过三个月.
  3. 当aggregate为 1 时, 会将所有维度的数据聚合累加.
  4. 同时提供了labelIdList和labelNameList的情况下，优先以labelIdList为主进行精确查询；仅提供labelNameList时，以列表中的所有labelName进行模糊查询

请求示例:

http://api2.sendcloud.net/api/statday/list?apiUser=***&apiKey=***&days=2&domainList=***;***

http://api2.sendcloud.net/api/statday/list?apiUser=***&apiKey=***&startDate=2015-02-01&endDate=2015-02-28&apiUserList=***;***

http://api2.sendcloud.net/api/statday/list?apiUser=***&apiKey=***&startDate=2015-02-01&endDate=2015-02-28&apiUserList=***;***&aggregate=1
1
2
3
4
5

返回值说明

参数 说明
sendDate 发送日期
apiUser API_USER
domain 收信域名
labelId 标签ID
labelName 标签名
requestNum 请求总数
deliveredNum 送达数量
clickNum 点击数量
openNum 打开数量
bounceNum 弹回数量
spamReportedNum 垃圾举报数量
unsubscribeNum 取消订阅数量
uniqueOpensNum 独立打开数量
uniqueClicksNum 独立点击数量
invalidEmailsNum 无效邮件数量
deliveredPercent 送达比例
clickPercent 点击比例
openPercent 打开比例
bouncePercent 弹回比例
spamReportedPercent 垃圾举报比例
unsubscribePercent 取消订阅比例
uniqueOpensPercent 独立打开比例
uniqueClicksPercent 独立点击比例
invalidEmailsPercent 无效邮件比例

​
返回值示例:

{
    "statusCode":200,
    "info": {
       "dataList": [
         {
            "sendDate": "2015-03-12",
            "apiUser": "...",
            "domain": "ifaxin.com",
            "labelId": 0,
            "labelName": null,
            "requestNum": 20,
            "deliveredNum": 0,
            "clickNum": 0,
            "openNum": 0,
            "bounceNum": 0,
            "spamReportedNum": 0,
            "unsubscribeNum": 0,
            "uniqueOpensNum": 0,
            "uniqueClicksNum": 0,
            "invalidEmailsNum": 20,
            "deliveredPercent": 0,
            "clickPercent": 0,
            "openPercent": 0,
            "bouncePercent": 0,
            "spamReportedPercent": 0,
            "unsubscribePercent": 0,
            "uniqueOpensPercent": 0,
            "uniqueClicksPercent": 0,
            "invalidEmailsPercent": 100
          },
          {
            "sendDate": "2015-03-12",
            "apiUser": "...",
            "domain": "qq.com",
            "labelId": 0,
            "labelName": null,
            "requestNum": 27,
            "deliveredNum": 27,
            "clickNum": 0,
            "openNum": 0,
            "bounceNum": 0,
            "spamReportedNum": 0,
            "unsubscribeNum": 0,
            "uniqueOpensNum": 0,
            "uniqueClicksNum": 0,
            "invalidEmailsNum": 0,
            "deliveredPercent": 100,
            "clickPercent": 0,
            "openPercent": 0,
            "bouncePercent": 0,
            "spamReportedPercent": 0,
            "unsubscribePercent": 0,
            "uniqueOpensPercent": 0,
            "uniqueClicksPercent": 0,
            "invalidEmailsPercent": 0
          }
      ]
    },
    "message": "request was successful",
    "result": true
}

# 聚合数据, aggregate = 1
{
    "statusCode":200,
    "info": {
      "dataList": {
        "requestNum": 48,
        "deliveredNum": 28,
        "clickNum": 0,
        "openNum": 0,
        "bounceNum": 0,
        "spamReportedNum": 0,
        "unsubscribeNum": 0,
        "uniqueOpenNum": 0,
        "uniqueClickNum": 0,
        "invalidEmailNum": 20,
        "deliveredPercent": 58.33,
        "clickPercent": 0,
        "openPercent": 0,
        "bouncePercent": 0,
        "spamReportedPercent": 0,
        "unsubscribePercent": 0,
        "uniqueOpensPercent": 0,
        "uniqueClicksPercent": 0,
        "invalidEmailsPercent": 41.66         
      },
    "message": "request was successful",
    "result": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# 发送数据统计 (每小时)

按小时统计的邮件数据

URL

https://api2.sendcloud.net/api/stathour/list
1

HTTP请求方式

post    get
1

参数说明

参数 类型 必须 说明
apiUser string 是 API_USER
apiKey string 是 API_KEY
days int * 过去 days 天内的统计数据 (days=1表示今天)
startDate string * 开始日期, 格式为yyyy-MM-dd
endDate string * 结束日期, 格式为yyyy-MM-dd
apiUserList string 否 获取指定 API_USER 的统计数据, 多个 API_USER 用;分开, 如:apiUserList=a;b;c
labelIdList string 否 获取指定标签下的统计数据, 多个标签用;分开, 如:labelIdList=a;b;c
labelNameList string 否 获取指定标签名下的统计数据, 多个标签用;分开(中文名称以UTF-8编码), 如:labelIdList=a;b;c

提示:

  1. 获取统计数据时, 必须指定时间区间. 即 startDate 与 endDate 的组合 或者 days 参数, 需二者取一.
  2. 查询的天数不超过 三个月.
  3. 同时提供了labelIdList和labelNameList的情况下，优先以labelIdList为主进行精确查询；仅提供labelNameList时，以列表中的所有labelName进行模糊查询

请求示例:

http://api2.sendcloud.net/api/stathour/list?apiUser=***&apiKey=***&days=2

http://api2.sendcloud.net/api/stathour/list?apiUser=***&apiKey=***&startDate=2015-02-01&endDate=2015-02-28&apiUserList=***;***
1
2
3

返回值说明

参数 说明
sendDate 发送日期
apiUser API_USER
labelId 标签ID
labelName 标签名
sendHour 某小时, 取值区间 [0-23]
requestNum 请求总数
deliveredNum 送达数量
clickNum 点击数量
openNum 打开数量
bounceNum 弹回数量
spamReportedNum 垃圾举报数量
unsubscribeNum 取消订阅数量
uniqueOpensNum 独立打开数量
uniqueClicksNum 独立点击数量
invalidEmailsNum 无效邮件数量
deliveredPercent 送达比例
clickPercent 点击比例
openPercent 打开比例
bouncePercent 弹回比例
spamReportedPercent 垃圾举报比例
unsubscribePercent 取消订阅比例
uniqueOpensPercent 独立打开比例
uniqueClicksPercent 独立点击比例
invalidEmailsPercent 无效邮件比例

返回值示例:

# sendHour 没有返回的时间点, 表示那个小时没有数据
{
    

    "statusCode":200,
    "info":{
      "dataList": [
           {
            "sendDate": "2015-03-12",
            "apiUser": "...",
            "labelId": 0,
            "labelId": "",
            "sendHour": 10, # 10点请求的邮件数据
            "requestNum": 8,
            "deliveredNum": 3,
            "clickNum": 0,
            "openNum": 0,
            "bounceNum": 0,
            "spamReportedNum": 0,
            "unsubscribeNum": 0,
            "uniqueOpensNum": 0,
            "uniqueClicksNum": 0,
            "invalidEmailsNum": 5,
            "deliveredPercent": 75,
            "clickPercent": 0,
            "openPercent": 0,
            "bouncePercent": 0,
            "spamReportedPercent": 0,
            "unsubscribePercent": 0,
            "uniqueOpensPercent": 0,
            "uniqueClickspercent": 0,
            "invalidEmailsPercent": 62.5
           }
       ],
    "message": "request was successful",
    "result": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# 无效邮件统计

查询无效邮件的分类统计信息

URL

https://api2.sendcloud.net/api/invalidstat/list
1

HTTP请求方式

post    get
1

参数说明

参数 类型 必须 说明
apiUser string 是 API_USER
apiKey string 是 API_KEY
days int * 过去 days 天内的统计数据 (days=1表示今天)
startDate string * 开始日期, 格式为yyyy-MM-dd
endDate string * 结束日期, 格式为yyyy-MM-dd
apiUserList string 否 获取指定 API_USER 的统计数据, 多个 API_USER 用;分开, 如:apiUserList=a;b;c
labelIdList string 否 获取指定标签下的统计数据, 多个标签用;分开, 如:labelIdList=a;b;c
labelNameList string 否 获取指定标签名下的统计数据, 多个标签用;分开(中文名称以UTF-8编码), 如:labelIdList=a;b;c
domainList string 否 获取指定收信域名下的统计数据, 多个域名用;分开, 如:domainList=a;b;c
aggregate int(1, 0) 否 默认为0. 如果为1, 则返回聚合数据

提示:

  1. 获取统计数据时, 必须指定时间区间. 即 startDate 与 endDate 的组合 或者 days 参数 需二者取一.
  2. 查询天数不超过三个月.
  3. 当aggregate为 1 时, 会将所有维度的数据聚合累加.
  4. 同时提供了labelIdList和labelNameList的情况下，优先以labelIdList为主进行精确查询；仅提供labelNameList时，以列表中的所有labelName进行模糊查询

请求示例:

https://api2.sendcloud.net/api/invalidstat/list?apiUser=***&apiKey=***&startDate=2015-03-12&endDate=2015-03-12
1

返回值说明

参数 说明
sendDate 发送日期，格式为yyyy-MM-dd
apiUser API_USER
labelId 标签ID
labelName 标签名称
domain 收信域名
sendcloudBlacklist 在sendcloud黑名单的个数
ubsubscribe 在取消订阅列表的个数
espUnvaliable esp服务器不可达的个数
recipientAddressError 收件人格式错误的个数
ipOrDomainRejected ip或者域名被拒个数
recipientNotFound 收件人不存在个数
spamEmail 垃圾邮件个数
senderOrRecipientRejected 发信人或者收件人被拒个数
others 其他

返回值示例:

{
  "statusCode":200,
  "info":{
    "dataList":[
       {
        "sendDate":"2016-02-01",
        "apiUser":"postmaster@delong.sendcloud.org",
        "labelId":5285,
        "labelName":"中文测试1", 
        "domain":"gmail.com",
        "sendcloudBlacklist":1,
        "ubsubscribe":0,
        "espUnvaliable":0,
        "recipientAddressError":0,
        "recipientNotFound":0,
        "spamEmail":0,
        "senderOrRecipientRejected":0,
        "others":0
       }
   ]
  },
  "message": "request was successful",
  "result": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
上次更新: 2025/03/25 10:38:59

投递回应

发送数据统计 (每天)
发送数据统计 (每小时)
无效邮件统计