打开点击

用户打开或点击的邮件,此用户的地址会进入打开点击列表.

你可以对此列表进行查询操作.


查询

URL

https://api.sendcloud.net/apiv2/openandclick/list

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
apiUser string API_USER
apiKey string API_KEY
days int * 过去 days 天内的统计数据 (days=1表示今天)
startDate string * 开始日期, 格式为yyyy-MM-dd
endDate string * 结束日期, 格式为yyyy-MM-dd
email string * 查询该地址在打开点击列表中的详情
trackType string 1表示打开,2表示点击,不传此参数查询打开和点击全部
apiUserList string 获取指定API_USER的统计数据,多个API_USER用分开,如:apiUserList=a;b;c
labelId string 获取指定标签下的统计数据
labelName string 获取指定标签名下的统计数据(中文名称以UTF-8编码)
start int 查询起始位置, 取值区间 [0-], 默认为 0
limit int 查询个数, 取值区间 [0-100], 默认为 100
timeType string 时间类型:0请求时间、1触发时间 默认 0

提示:

  1. 如果指定时间区间, 则是查询此时间区间内的打开点击数据列表. 注意: startDate 与 endDate 的组合 或者 days 参数, 二者取一.
  2. 查询的天数不超过三个月.
  3. 如果指定email,不指定时间区间, 默认是查询最近三个月数据。如果需要根据时间区间查询,带上days参数或者startDate 和endDate即可
  4. 如果不指定apiUserList,默认查询所有记录.

请求示例:

https://api.sendcloud.net/apiv2/openandclick/list?apiUser=***&apiKey=***&days=100&start=0&limit=3 

返回值说明

参数 说明
email 邮件地址
trackType 点击或者打开类型
url 点击的url
apiUser apiUser名称
requestTime 邮件请求成功时间
currTime 点击或者打开的发生时间
emailId SendCloud 投递一封邮件, 返回的邮件编号, 可以对应到某一次请求的某一个收件人
ip 点击或者打开的ip
country ip的归属国家
province ip的归属省份
city ip的归属城市
browser 使用的浏览器名称
device 使用的移动设备名称

返回值示例:

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "total": 1,
        "dataList": [
            {
                "trackType": 1,
                "apiUser": "sendcloud_ops",
                "email": "ops@sendcloud.im",
                "url": "",
                "currTime": "2021-06-09 09:49:30",
                "emailId": "1623200473337_143833_116562_2325.sc-10_9_13_213-inbound0$ops@sendcloud.im",
                "requestTime": "2021-06-09 09:01:13",
                "ip": "47.190.78.5",
                "country": "United States",
                "province": "Texas",
                "city": "Southlake",
                "browser": "谷歌",
                "device": ""
            }
        ],
        "count": 1
    }
}