功能说明
查询全员推送(App 推送)的统计数据,支持按任务 ID 过滤,返回各平台维度的推送统计。查询时间范围最大为最近 30 天,支持分页。
请求 URL 示例
https://xxxxxx/v4/timpush_query/statistics?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
https | 请求协议:HTTPS。 请求方式:POST。 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名。 中国: console.tim.qq.com新加坡: adminapisgp.im.qcloud.com首尔: adminapikr.im.qcloud.com东京: adminapijpn.im.qcloud.com法兰克福: adminapiger.im.qcloud.com硅谷: adminapiusa.im.qcloud.com雅加达: adminapiidn.im.qcloud.com利雅得: adminapiksa.im.qcloud.com |
v4/timpush_query/statistics | 请求接口。 |
usersig | |
identifier | |
sdkappid | 创建应用时即时通信控制台分配的 SdkAppid。 |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 固定值为:json。 |
调用频率限制
每秒20次。
请求包示例
{"StartTime": 1710000000,"EndTime": 1710600000,"TaskID": ["task_001", "task_002"],"Offset": 0,"Limit": 10}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
StartTime | Integer | 必填 | 查询起始时间,Unix 时间戳(秒)。与 EndTime 的区间最大为最近 30 天。 |
EndTime | Integer | 必填 | 查询结束时间,Unix 时间戳(秒)。必须大于 StartTime。 |
TaskID | Array | 选填 | 推送任务 ID 列表,最多 5 个。不传则查询时间范围内所有任务的汇总数据,不会逐一返回每条任务。 |
Offset | Integer | 选填 | 分页偏移量,默认 0。 |
Limit | Integer | 选填 | 每页返回的记录数,默认 20。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","Results": [{"TaskID": "task_001","TotalCount": 10000,"SentCount": 9500,"DeliveredCount": 8000,"ClickCount": 3000,"PlatformStatistics": [{"EventType": 1,"PushPlatform": 1,"TotalCount": 5000,"SentCount": 4800,"SentSuccCount": 0,"DeliveredCount": 4000,"DeniedCount": 0,"ClickCount": 1500},{"EventType": 1,"PushPlatform": 3,"TotalCount": 5000,"SentCount": 4700,"SentSuccCount": 0,"DeliveredCount": 4000,"DeniedCount": 0,"ClickCount": 1500}]}],"TotalNum": 1, //符合条件的任务有1条"IsCompleteFlag": true,"NextOffset": 0}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果: OK:表示处理成功。 FAIL:表示失败。 |
ErrorCode | Integer | 错误码。0 表示成功,非 0 表示失败。 |
ErrorInfo | String | 错误信息。 |
Results | Array | 统计结果数组,每个元素对应一个推送任务的统计数据。 |
TotalNum | Integer | 符合条件的任务统计记录总数。 |
IsCompleteFlag | Boolean | 是否已获取完所有数据。true:已完整返回,false:还有更多数据,需翻页。 |
NextOffset | Integer | 下次请求的起始偏移量,用于翻页。 |
Results 数组中 json Object 字段说明
字段 | 类型 | 说明 |
TaskID | String | 推送任务 ID。 |
TotalCount | Integer | 推送目标总数。 |
SentCount | Integer | 实际发送数。 |
DeliveredCount | Integer | 触达设备数。 |
ClickCount | Integer | 点击数。 |
PlatformStatistics | Array | 按推送平台维度的统计数据数组。 |
PlatformStatistics 数组中 json Object 字段说明
字段 | 类型 | 说明 |
EventType | Integer | 推送方式。1:离线推送,2:在线推送。不填表示汇总。 |
PushPlatform | Integer | 推送平台。1:APNS,2:小米,3:华为,4:FCM,5:魅族,6:OPPO,7:vivo,8:荣耀,9:鸿蒙。 |
TotalCount | Integer | 该平台推送目标总数。 |
SentCount | Integer | 该平台实际发送数。 |
SentSuccCount | Integer | 该平台发送成功数。 |
DeliveredCount | Integer | 该平台触达设备数。 |
DeniedCount | Integer | 该平台拒绝数。 |
ClickCount | Integer | 该平台点击数。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 含义说明 |
90100 | 请求参数无效(JSON 格式错误、StartTime 大于 EndTime、TaskID 超过 5 个等)。 |
90102 | 服务内部错误,请稍后重试。 |
接口调试工具
参考