所有统计报表都可以在开发者中心查看。点此查看使用说明,此处接口可以整合到开发者自身的系统中。
查询推送数据,可查询消息有效可下发总数,消息回执总数和用户点击数等结果。支持单个taskId查询和多个taskId查询。
此接口调用,需要是toList或toApp的taskId才可以查询推送结果数据。
/report/push/task/$taskid,$taskid
GET
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
taskid | String | 是 | 无 | 任务id,推送时返回,多个taskId以英文逗号隔开,一次最多传200个 |
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
token | String | 是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
actionIdList | String | 否 | 无 | 详见文档自定义事件 |
content-type:application/json;charset=utf-8
返回值示例
{
"code":0,
"msg":"success",
"data": {
"$taskid": {
"total": {
"msg_num":4,
"target_num":4,
"receive_num":4,
"display_num":2,
"click_num":2
},
"gt": {
"target_num":2,
"receive_num":2,
"display_num":1,
"click_num":1
},
"actionCntMap": {
"$actionId":2
}
}
}
}
返回结构说明请参考公共返回结构
返回参数data
说明
名称 | 类型 | 描述 |
---|---|---|
$taskid | Json | key: 任务编号,value: 统计数据 |
total | Json | 总的统计数据 |
gt | Json | key表示厂商通道,value表示该通道的统计数据。其中 gt: 个推通道; ios: APN;st: 坚果; key还可以是hw、xm、vv、mz、op。 |
msg_num | Number | 消息可下发数 |
target_num | Number | 消息下发数 |
receive_num | Number | 消息接收数 |
display_num | Number | 消息展示数 |
click_num | Number | 消息点击数 |
actionCntMap | Json | 自定义事件统计数据 |
$actionId | Number | $actionId为自定义事件id,对应的值表示对应的统计数据(由开发者打点统计) |
curl $BaseUrl/report/push/task/$taskid,$taskid -H "token: xxx"
根据任务组名查询推送结果,返回结果包括百日内联网用户数(活跃用户数)、实际下发数、到达数、展示数、点击数。
/report/push/task_group/$group_name
GET
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
group_name | String | 是 | 无 | 任务组名 |
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
token | String | 是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
content-type:application/json;charset=utf-8
返回值示例
{
"code":"0",
"msg":"success",
"data": {
"$group_name": {
"total": {
"msg_num":4,
"target_num":4,
"receive_num":4,
"display_num":2,
"click_num":2
},
"gt": {
"target_num":2,
"receive_num":2,
"display_num":1,
"click_num":1
},
"ios": {
"target_num":2,
"receive_num":2,
"display_num":1,
"click_num":1
}
}
}
}
返回结构说明请参考公共返回结构
返回参数data
说明
名称 | 类型 | 描述 |
---|---|---|
$group_name | Json | key任务编号,value: 统计数据 |
total | Json | 总的统计数据 |
gt | Json | key表示厂商通道,value表示该通道的统计数据。其中 gt: 个推通道; ios: APN;st: 坚果; key还可以是hw、xm、vv、mz、op。 |
msg_num | Number | 消息可下发数 |
target_num | Number | 消息下发数 |
receive_num | Number | 消息接收数 |
display_num | Number | 消息展示数 |
click_num | Number | 消息点击数 |
curl $BaseUrl/report/push/task_group/$group_name -H "token: xxx"
调用此接口可以获取某个应用单日的推送数据(推送数据包括:发送总数,在线发送数,接收数,展示数,点击数)(目前只支持查询非当天的数据)
/report/push/date/$date
GET
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
date | String | 是 | 无 | 日期,格式: yyyy-MM-dd |
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
token | String | 是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
content-type:application/json;charset=utf-8
返回值示例
{
"code":0,
"msg":"success",
"data": {
"$date": {
"total": {
"target_num":4,
"receive_num":4,
"display_num":2,
"click_num":2
},
"gt": {
"target_num":2,
"receive_num":2,
"display_num":1,
"click_num":1
},
"hw": {
"target_num":2,
"receive_num":2,
"display_num":1,
"click_num":1
}
}
}
}
返回结构说明请参考公共返回结构
返回参数data
说明
名称 | 类型 | 描述 |
---|---|---|
$date | Json | key: 日期,格式: yyyy-MM-dd,value: 统计数据 |
total | Json | 总的统计数据 |
gt | Json | key表示厂商通道,value表示该通道的统计数据。其中 gt: 个推通道; ios: APN;st: 坚果; key还可以是hw、xm、vv、mz、op。 |
target_num | Number | 消息下发数 |
receive_num | Number | 消息接收数 |
display_num | Number | 消息展示数 |
click_num | Number | 消息点击数 |
curl $BaseUrl/report/push/date/$date -H "token: xxx"
调用此接口可以获取某个应用单日的用户数据(用户数据包括:新增用户数,累计注册用户总数,在线峰值,日联网用户数)(目前只支持查询非当天的数据)
/report/user/date/$date
GET
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
date | String | 是 | 无 | 日期,格式: yyyy-MM-dd |
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
token | String | 是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
content-type:application/json;charset=utf-8
返回值示例
{
"code":0,
"msg":"success",
"data": {
"$date": {
"accumulative_num":9,
"register_num":2,
"active_num":5,
"online_num":2
}
}
}
返回结构说明请参考公共返回结构
返回参数data
说明
名称 | 类型 | 描述 |
---|---|---|
$date | Json | key: 日期,格式: yyyy-MM-dd,value: 统计数据 |
accumulative_num | Number | 累计注册用户数 |
register_num | Number | 注册用户数 |
active_num | Number | 活跃用户数 |
online_num | Number | 在线用户数 |
curl $BaseUrl/report/user/date/$date -H "token: xxx"
查询当前时间一天内的在线用户数(10分钟一个点,1个小时六个点)
/report/online_user
GET
名称 | 类型 | 是否必须 | 默认值 | 说明 |
---|---|---|---|---|
token | String | 是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
content-type:application/json;charset=utf-8
返回值示例
{
"code":0,
"msg":"success",
"data": {
"online_statics":{
"$date":4,
"$date":5
}
}
}
返回结构说明请参考公共返回结构
返回参数data
说明
名称 | 类型 | 描述 |
---|---|---|
online_statics | Json | 在线用户统计数据 |
$date | Number | key: 毫秒时间戳,value: 在线用户数 |
curl $BaseUrl/report/online_user -H "token: xxx"