打开点击列表

最新更新:2023-08-10

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

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

查询

URL

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

        
此代码块在浮窗中显示

HTTP 请求方法

GET
          GET

        
此代码块在浮窗中显示

Header

Header 类型 是否必需 描述
Authorization string true Basic base64(api_user:api_key)

查询参数描述

参数 类型 是否必需 描述
time_zone string * 时区,例如:+8,默认 +8
start_date string * 开始日期格式为 yyyy-MM-dd
end_date string * 结束日期格式为 yyyy-MM-dd
email string * 查询该地址在打开点击列表中的详情
track_type string 1 表示打开,2 表示点击,不传此参数查询打开和点击全部
api_users string 获取指定API_USER的统计数据,多个API_USER用分开,如:apiUserList=a;b;c
label_ids string 获取指定标签的统计数据;多个标签用分号分隔,例如,label_ids=a;b;c
offset int 查询位置,取值区间[0-],默认为 0
limit int 查询个数,取值区间[0-100],默认为 100

请求示例:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/track-details?offset=0&limit=3'
          curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/track-details?offset=0&limit=3' 

        
此代码块在浮窗中显示

返回值描述

参数 描述
email 邮件地址
label_id 邮件标签 ID
track_type 点击或者打开类型
url 点击的 URL
api_user API_USER名称
curr_time 点击或者打开的发生时间
ip 点击或者打开的IP
country IP的归属国家
province IP的归属省份
city IP 的归属城市
browser 使用的浏览器名称
device 使用的设备名称

返回值示例:

{ "result": [ { "email": "opfwefs@gmail.com", "track_type": 1, "api_user": "sendcloud_op**s", "url": "", "curr_time": "2021-06-09 09:49:30", "email_id": "162320******_143833_116562_2325.sc-10_9_13_213-inbound0$ops@send.im", "ip": "47.190.78.5", "country": "United States", "province": "Texas", "city": "Southlake", "browser": "google", "device": "" } ], "count": 1, "total": 2 }
          { 
   "result": [
        {
            "email": "opfwefs@gmail.com",
            "track_type": 1,
            "api_user": "sendcloud_op**s",
            "url": "",
            "curr_time": "2021-06-09 09:49:30",
            "email_id": "162320******_143833_116562_2325.sc-10_9_13_213-inbound0$ops@send.im",
            "ip": "47.190.78.5",
            "country": "United States",
            "province": "Texas",
            "city": "Southlake",
            "browser": "google",
            "device": ""
        }
    ],
    "count": 1,
    "total": 2
}

        
此代码块在浮窗中显示
在文档中心打开