此SDK已停止维护,请开发者对接 RestApi V2
统计API
简述
所有统计报表都可以在开发者中心查看。点此查看使用说明,此处接口可以整合到开发者自身的系统中。
【推送】获取推送结果
功能描述
调用此接口查询推送数据,可查询消息有效可下发总数,消息回执总数等结果。
限制说明
此接口调用,需要是toList或toApp的taskId才可以查询推送结果数据。
接口名称
getPushResult($taskId)
请求参数
参数 |
类型 |
请求参数 |
$taskId |
String |
任务唯一识别号(格式OSL-MMdd_XXXXXX) |
返回参数
名称 |
类型 |
描述 |
result |
String |
请求结果,其他返回结果详见错误返回值 |
taskId |
String |
任务ID |
msgProcess |
String |
个推达到数(因为历史原因存在,以后会取消) |
clickNum |
String |
个推点击数(因为历史原因存在,以后会取消) |
pushNum |
String |
个推下发数(因为历史原因存在,以后会取消) |
feedbackTotal |
String |
各渠道总到达数 |
clickTotal |
String |
各渠道总点击数 |
displayTotal |
String |
各渠道总展示数 |
sentTotal |
String |
各渠道总下发数 |
GT |
Array |
个推下发 |
APN |
Array |
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": ""
},
"APN": {
"sent": "",
"displayed": "",
"clicked": "",
"feedback": "",
"result": ""
}
}
【推送】批量获取推送结果
功能描述
调用此接口批量查询推送数据,可查询消息有效可下发总数,消息回执总数,用户点击数结果。
限制说明
此接口调用,需要是toList或toApp的taskId才可以查询推送结果数据。
接口名称
function getPushResultByTaskidList($taskIdList)
请求参数
参数名 |
类型 |
必需 |
默认值 |
参数描述 |
$taskIdList |
Array |
是 |
无 |
任务Id列表 |
返回示例
{
"result": "ok",
"resultList":[
{
"taskId":"",
"msgProcess":"",
"clickNum":"",
"pushNum":"",
"feedbackTotal":"",
"clickTotal":"",
"displayTotal":"",
"sentTotal":"",
"GT": {
"sent": "",
"displayed": "",
"clicked": "",
"feedback": "",
"result": ""
},
"APN": {
"sent": "",
"displayed": "",
"clicked": "",
"feedback": "",
"result": ""
}
}
]
}
【推送】获取任务组名推送结果
功能描述
根据任务组名查询推送结果,返回结果包括百日内联网用户数(活跃用户数)、实际下发数、到达数、展示数、点击数。
接口名称
getPushResultByGroupName($appId,$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 |
Array |
个推下发 |
APN |
Array |
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": ""
},
"APN": {
"sent": "",
"displayed": "",
"clicked": "",
"feedback": "",
"result": ""
}
}
【推送】获取单日推送数据
功能描述
调用此接口可以获取某个应用单日的推送数据(推送数据包括:发送总数,在线发送数,接收数,展示数,点击数)(目前只支持查询非当天的数据)
接口名称
queryAppPushDataByDate(APPID,DATE)
请求参数
字段 |
类型 |
说明 |
$appId |
String |
应用ID |
$date |
String |
查询的日期(格式:yyyyMMdd) |
返回参数
名称 |
类型 |
描述 |
result |
String |
请求结果,其他返回结果详见错误返回值 |
data |
Array |
整体数据 |
GT |
Array |
个推下发 |
APN |
Array |
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":"",
},
"GT": {
"sent": "",
"displayed": "",
"clicked": "",
"feedback": "",
"result": ""
},
"APN": {
"sent": "",
"displayed": "",
"clicked": "",
"feedback": "",
"result": ""
}
}
【用户】获取24小时在线用户数
功能描述
通过接口查询当前时间一天内的在线数(十分钟一个点,一小时六个点)
接口名称
getLast24HoursOnlineUserStatistics($appId)
请求参数
参数名 |
类型 |
必需 |
默认值 |
参数描述 |
$appId |
String |
是 |
无 |
appId |
返回值
字段 |
取值 |
说明 |
result |
String |
请求结果 |
appId |
String |
用户appId |
onlineStatics |
Array |
24小时用户在线数统计 |
返回示例
{
"result":"ok",
"appId":"",
"onlineStatics":{
"1565774989870":10,
"1565771049870":20
}
}
【用户】获取单日用户数据
功能描述
调用此接口可以获取某个应用单日的用户数据(用户数据包括:新增用户数,累计注册用户总数,在线峰值,日联网用户数)(目前只支持查询非当天的数据)
接口名称
queryAppUserDataByDate(APPID , DATE)
请求参数
字段 |
类型 |
说明 |
$appId |
String |
应用ID |
$date |
String |
查询的日期(格式:yyyyMMdd) |
返回参数
名称 |
类型 |
描述 |
result |
String |
请求结果,其他返回结果详见错误返回值 |
data |
Array |
查询数据对象 |
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
}
}
【用户】查询符合条件的用户数
功能描述
通过接口查询符合当前查询条件的用户数
接口名称
queryUserCount($appId, $appConditions)
请求参数
参数名 |
类型 |
必需 |
默认值 |
参数描述 |
$appId |
String |
是 |
无 |
appId |
$conditions |
AppConditions |
是 |
无 |
conditions 具体参数格式 |
返回参数
名称 |
类型 |
描述 |
result |
String |
请求结果,其他返回结果详见错误返回值 |
user_count |
long |
符合条件用户数 |
返回示例
{
"result":"Success",
"user_count":123
}
【用户】查询用户画像
功能描述
通过接口查询个推大数据得出的用户画像标签,该接口需要申请后才可正常使用,且主要是让APP查看自己能使用哪些标签进行推送
限制说明
申请用户画像标签请点击右侧“技术咨询”了解详情 。
接口名称
getPersonaTags(APPID)
请求参数
字段 |
类型 |
说明 |
$appId |
String |
应用ID |
返回参数
名称 |
类型 |
描述 |
result |
String |
请求结果,其他返回结果详见错误返回值 |
tags |
Array |
个推大数据得出的用户画像标签,参考标签文件 |
返回示例
{
"result":"Success",
"tags":[
{
"group":"",
"desc":"",
"list":[
{
"id":"",
"desc":""
}
]
}
]
}