此SDK已停止维护,请开发者对接 RestApi V2
统计API,GitHub示例点此查看
所有统计报表都可以在开发者中心查看。点此查看使用说明,此处接口可以整合到开发者自身的系统中。
调用此接口查询推送数据,可查询消息有效可下发总数,消息回执总数,用户点击数等结果。
此接口调用,需要是toList或toApp的taskId才可以查询推送结果数据。
IPushResult getPushResult(String taskId);
名称 | 类型 | 是否必需 | 默认值 | 描述 |
---|---|---|---|---|
taskId | String | 是 | 无 | 任务Id |
名称 | 类型 | 描述 |
---|---|---|
result | String | 请求结果,其他返回结果详见错误返回值 |
taskId | String | 任务ID |
msgProcess | String | 个推达到数(因为历史原因存在,以后会取消) |
clickNum | String | 个推点击数(因为历史原因存在,以后会取消) |
pushNum | String | 个推下发数(因为历史原因存在,以后会取消) |
feedbackTotal | String | 各渠道总到达数 |
clickTotal | String | 各渠道总点击数 |
displayTotal | String | 各渠道总展示数 |
sentTotal | String | 各渠道总下发数 |
GT | JsonObject | 个推下发 |
APN | JsonObject | ios apn下发 |
GT 和 APN
名称 | 类型 | 描述 |
---|---|---|
sent | String | 成功下发数 |
displayed | String | 展示数 |
clicked | String | 点击数 |
feedback | String | 到达数 |
result | String | 成功(ok)或错误信息 |
{
"result": "ok",
"taskId": "",
"msgProcess":"",//个推达到数
"clickNum":"",//个推点击数
"pushNum":"",//个推下发数
"feedbackTotal":"",//各渠道总到达
"clickTotal":"",//各渠道总点击
"displayTotal":"",//各渠道总展示
"sentTotal":"",//各渠道总下发
"GT": {//个推下发
"sent": "",//成功下发数
"displayed": "",//展示数
"clicked": "",//点击
"feedback": "",//到达
"result": ""//成功(ok)或错误信息
},
"APN": {//ios apn下发
"sent": "",//下发
"displayed": "",//展示
"clicked": "",//点击
"feedback": "",//到达
"result": ""//成功(ok)或错误信息
}
}
调用此接口批量查询推送数据,可查询消息有效可下发总数,消息回执总数,用户点击数结果。
此接口调用,需要是toList或toApp的taskId才可以查询推送结果数据。
IPushResult getPushResultByTaskidList(List<String> taskIdList);
名称 | 类型 | 是否必需 | 默认值 | 描述 |
---|---|---|---|---|
taskIdList | List<String> | 是 | 无 | 任务Id列表 |
名称 | 类型 | 描述 |
---|---|---|
result | String | 请求结果,其他返回结果详见错误返回值 |
resultList | JSONArray | 参考推送结果返回参数 |
{
"result": "ok",
"resultList":[
{
"taskId":"",
"msgProcess":"",//个推达到数
"clickNum":"",//个推点击数
"pushNum":"",//个推下发数
"feedbackTotal":"",//各渠道总到达数
"clickTotal":"",//各渠道总点击数
"displayTotal":"",//各渠道总展示数
"sentTotal":"",//各渠道总下发数
"GT": {//个推下发报表
"sent": "",//成功下发数
"displayed": "",//展示数
"clicked": "",//点击
"feedback": "",//到达
"result": ""//成功(ok)或错误信息
},
"APN": {//ios apns下发
"sent": "",//下发
"displayed": "",//展示
"clicked": "",//点击
"feedback": "",//到达
"result": ""//成功(ok)或错误信息
}
}
]
}
根据任务组名查询推送结果,返回结果包括百日内联网用户数(活跃用户数)、实际下发数、到达数、展示数、点击数。
IQueryResult getPushResultByGroupName(String appId, String groupName);
名称 | 类型 | 是否必需 | 默认值 | 描述 |
---|---|---|---|---|
appId | String | 是 | 无 | 应用唯一ID |
groupName | String | 是 | 无 | 推送任务组名 |
名称 | 类型 | 描述 |
---|---|---|
result | String | 请求结果,其他返回结果详见错误返回值 |
groupName | String | 任务组名 |
msgTotal | String | 百日联网用户数 |
msgProcess | String | 个推达到数 |
clickNum | String | 个推点击数 |
onlineNum | String | 个推下发数 |
feedbackTotal | String | 各渠道总到达数 |
clickTotal | String | 各渠道总点击数 |
displayTotal | String | 各渠道总展示数 |
sentTotal | String | 各渠道总下发数 |
GT | JsonObject | 个推下发 |
APN | JsonObject | iOS APNs下发 |
GT 和 APN
名称 | 类型 | 描述 |
---|---|---|
sent | String | 成功下发数 |
displayed | String | 展示数 |
clicked | String | 点击数 |
feedback | String | 到达数 |
result | String | 成功(ok)或错误信息 |
{
"result": "ok",
"groupName": "",
"msgTotal": "", //百日联网用户数
"msgProcess":"",//个推达到数
"clickNum":"",//个推点击数
"onlineNum":"",//个推下发数
"feedbackTotal":"",//各渠道总到达
"clickTotal":"",//各渠道总点击
"displayTotal":"",//各渠道总展示
"sentTotal":"", //各渠道总下发
"GT": {//个推下发
"sent": "",//成功下发数
"displayed": "",//展示数
"clicked": "",//点击
"feedback": "",//到达
"result": ""//成功(ok)或错误信息
},
"APN": {//ios apn下发
"sent": "",//下发
"displayed": "",//展示
"clicked": "",//点击
"feedback": "",//到达
"result": ""//成功(ok)或错误信息
}
}
调用此接口可以获取某个应用单日的推送数据(推送数据包括:发送总数,在线发送数,接收数,展示数,点击数)(目前只支持查询非当天的数据)
IQueryResult queryAppPushDataByDate (String appId,String date);
名称 | 类型 | 是否必需 | 默认值 | 描述 |
---|---|---|---|---|
appId | String | 是 | 无 | 应用唯一ID |
date | String | 是 | 无 | 查询的日期(格式:yyyyMMdd) |
名称 | 类型 | 描述 |
---|---|---|
result | String | 请求结果,其他返回结果详见错误返回值 |
data | JsonObject | 整体数据 |
GT | JsonObject | 个推下发 |
APN | JsonObject | iOS APNs下发 |
data
名称 | 类型 | 描述 |
---|---|---|
appId | String | 应用唯一ID |
date | String | 查询的日期(格式:yyyyMMdd) |
sendCount | String | 个推预计下发数 |
sendOnlineCount | String | 个推下发数 |
receiveCount | String | 个推达到数 |
showCount | String | 个推展示数 |
clickCount | String | 个推点击数 |
GT 和 APN
名称 | 类型 | 描述 |
---|---|---|
sent | String | 成功下发数 |
displayed | String | 展示数 |
clicked | String | 点击数 |
feedback | String | 到达数 |
result | String | 成功(ok)或错误信息 |
{
"result": "ok",
"data": {
"appId":"",
"date":"",
"sendCount":"",//个推预计下发数
"sendOnlineCount":"",//个推下发数
"receiveCount":"",//个推达到数
"showCount":"",//个推展示数
"clickCount":"",//个推点击数
"sentTotal":"", //各渠道总下发
"displayTotal":"",//各渠道总展示
"clickTotal":"",//各渠道总点击
"feedbackTotal":"",//各渠道总到达
},
"GT": {//个推下发
"sent": "",//成功下发数
"displayed": "",//展示数
"clicked": "",//点击
"feedback": "",//到达
"result": ""//成功(ok)或错误信息
},
"APN": {//ios apns下发
"sent": "",//下发
"displayed": "",//展示
"clicked": "",//点击
"feedback": "",//到达
"result": ""//成功(ok)或错误信息
}
}
通过接口查询当前时间一天内的在线数(十分钟一个点,一小时六个点)
IQueryResult getLast24HoursOnlineUserStatistics(String appId);
名称 | 类型 | 是否必需 | 默认值 | 描述 |
---|---|---|---|---|
appId | String | 是 | 无 | 应用唯一ID |
名称 | 类型 | 描述 |
---|---|---|
result | String | 请求结果,其他返回结果详见错误返回值 |
appId | String | 整体数据 |
onlineStatics | JSONObject | 24小时用户在线数统计 |
{
"result":"ok",
"appId":"",
"onlineStatics":{
"1565774989870":10,
"1565775049870":20
}
}
调用此接口可以获取某个应用单日的用户数据(用户数据包括:新增用户数,累计注册用户总数,在线峰值,日联网用户数)(目前只支持查询非当天的数据)
IQueryResult queryAppUserDataByDate (String appId,String date);
名称 | 类型 | 是否必需 | 默认值 | 描述 |
---|---|---|---|---|
appId | String | 是 | 无 | 应用唯一ID |
date | String | 是 | 无 | 查询的日期(格式:yyyyMMdd) |
名称 | 类型 | 描述 |
---|---|---|
result | String | 请求结果,其他返回结果详见错误返回值 |
data | JSONObject | 查询数据对象 |
data
名称 | 类型 | 描述 |
---|---|---|
appId | String | 应用唯一ID |
date | String | 查询的日期(格式:yyyyMMdd) |
newRegistCount | int | 新注册用户数 |
registTotalCount | int | 累计注册用户数 |
activeCount | int | 活跃用户数 |
onlineCount | int | 最高同时在线用户数 |
{
"result":"Success",
"data":{
"appId":"",
"date":"yyyyMMdd",
"newRegistCount":0, //新注册用户数
"registTotalCount":0, //累计注册用户数
"activeCount":0, //活跃用户数
"onlineCount":0 //最高同时在线用户数
}
}
通过接口查询符合当前查询条件的用户数
IQueryResult queryUserCount(String appId, AppConditions conditions);
名称 | 类型 | 是否必需 | 默认值 | 描述 |
---|---|---|---|---|
appId | String | 是 | 无 | 应用唯一ID |
conditions | AppConditions | 是 | 无 | 查询条件 详见【toAPP】执行群推中此参数说明 |
名称 | 类型 | 描述 |
---|---|---|
result | String | 请求结果,其他返回结果详见错误返回值 |
user_count | long | 符合条件用户数 |
{
"result":"Success",
"user_count":123
}
通过接口查询个推大数据得出的用户画像标签,该接口需要申请后才可正常使用,且主要是让APP查看自己能使用哪些标签进行推送
IQueryResult getPersonaTags(String appId);
申请用户画像标签请点击右侧“技术咨询”了解详情 。
名称 | 类型 | 是否必需 | 默认值 | 描述 |
---|---|---|---|---|
appId | String | 是 | 无 | 应用唯一ID |
名称 | 类型 | 描述 |
---|---|---|
result | String | 请求结果,其他返回结果详见错误返回值 |
tags | JsonArray | 个推大数据得出的用户画像标签,参考标签文件 |
{
"result":"Success",
"tags":[
{
"group":"", //标签类型
"desc":"", //类型描述
"list":[
{
"id":"", //标签ID
"desc":"" //标签描述
}
]
}
]
}
以上文档对您是否有帮助?