统计API

统计API

简述

所有统计报表都可以在开发者中心查看。点此查看使用说明,此处接口可以整合到开发者自身的系统中。

【推送】获取推送结果

查询推送数据,可查询消息可下发数、下发数,接收数、展示数、点击数等结果。支持单个taskId查询和多个taskId查询。
此接口调用,可直接查询toList或toApp的taskId的推送结果数据;如需查询toSingle的taskId的推送结果数据,请联系对应的商务同学开通。

  • 接口地址: BaseUrl/report/push/task/$taskid,$taskid
  • 请求方式: GET

Request请求说明:

路径参数说明(路径中$开头的参数)

名称 类型 是否必须 默认值 说明
taskid String 任务id,推送时返回,多个taskId以英文逗号隔开,一次最多传200个

Header参数说明

名称 类型 是否必须 默认值 说明
token String 接口访问凭据,获取方式请参考获取鉴权token

Query参数说明

名称 类型 是否必须 默认值 说明
actionIdList String 详见文档自定义事件

Response响应说明

成功响应数据格式:

  • 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
            }
        }
    }
}
名称 类型 描述
$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" 

【推送】任务组名查报表

根据任务组名查询推送结果,返回结果包括消息可下发数、下发数,接收数、展示数、点击数。

  • 接口地址: BaseUrl/report/push/task_group/$group_name
  • 请求方式: GET

Request请求说明:

路径参数说明(路径中$开头的参数)

名称 类型 是否必须 默认值 说明
group_name String 任务组名

Header参数说明

名称 类型 是否必须 默认值 说明
token String 接口访问凭据,获取方式请参考获取鉴权token

Response响应说明

成功响应数据格式:

  • 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
            }
        }
    }
}
名称 类型 描述
$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" 

【推送】获取单日推送数据

调用此接口可以获取某个应用单日的推送数据(推送数据包括:下发数,接收数、展示数、点击数)(目前只支持查询非当天的数据)

  • 接口地址: BaseUrl/report/push/date/$date
  • 请求方式: GET

Request请求说明:

路径参数说明(路径中$开头的参数)

名称 类型 是否必须 默认值 说明
date String 日期,格式: yyyy-MM-dd

Header参数说明

名称 类型 是否必须 默认值 说明
token String 接口访问凭据,获取方式请参考获取鉴权token

Response响应说明

成功响应数据格式:

  • 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
            }
        }
    }
}
名称 类型 描述
$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" 

【推送】查询推送量

查询应用当日可推送量和推送余量

注意:
1. 部分厂商消息不限制推送量,所以此接口不做返回,例如 hw/xmg厂商,op的私信消息,xm的重要级别消息等等
2.vv返回的是请求量push_num,总限额total_num返回的总的到达量,所以会有请求量push_num超过总限额total_num的情况
3.该接口做了频控限制,请不要频繁调用

  • 接口地址: BaseUrl/report/push/count
  • 请求方式: GET

Request请求说明:

Header参数说明

名称 类型 是否必须 默认值 说明
token String 接口访问凭据,获取方式请参考获取鉴权token

Response响应说明

成功响应数据格式:

  • content-type:application/json;charset=utf-8

  • 返回值示例

{
    "msg":"success",
    "code":0,
    "data":{
        "vv":{
            "special":{
                "push_num":0,
                "total_num":"10000",
                "limit":false
            },
            "general":{
                "push_num":0,
                "total_num":"10000",
                "limit":false
            },
            "grouppush":{
                "push_num":0,
                "total_num":"1000",
                "limit":false
            }
        },
        "op":{
            "general":{
                "total_num":"100000",
                "limit":false,
                "remain_num":"100000"
            }
        },
        "xm":{
            "general":{
                "total_num":20000,
                "limit":false,
                "remain_num":20000
            }
        },
        "gt":{
            "app":{
                "total_num":3000,
                "limit":false,
                "remain_num":3000
            },
            "app_with_tag":{
                "total_num":1000,
                "limit":false,
                "remain_num":1000
            },
            "list":{
                "total_num":2000000,
                "limit":false,
                "remain_num":2000000
            }
        }
    }
}

为了接口返回统一,所以用special和general返回表示特殊消息和普通消息

名称 类型 描述
gt Object 个推通道
gt/app Object 个推群推接口推送限制
gt/list Object 个推创建消息接口限制
gt/app_with_tag Object 个推 根据条件筛选用户推送接口推送限制
xm Object xm通道
xm/general Object xm通道 普通消息限制,channel是普通级别消息时推送量限制
op Object op通道
op/general Object op通道 公信消息限制,不带channel或公信channel时推送量限制
vv Object vv通道
vv/special Object vv通道系统类消息限制,即classification=1时推送量限制
vv/general Object vv通道运营类消息限制,即classification=0时推送量限制
vv/grouppush Object vv群推消息体配置量
total_num long 单日可推送总量
remain_num long 单日可推送剩余量
push_num long 单日可推送请求量,仅vv返回该字段
limit boolean 是否被限量,当日可推送总量使用完时,该字段更新true

请求示例

curl $BaseUrl/report/push/count -H "token: xxx" 

【用户】获取单日用户数据接口

调用此接口可以获取某个应用单日的用户数据(用户数据包括:新增用户数,累计注册用户总数,在线峰值,日联网用户数)(目前只支持查询非当天的数据)

  • 接口地址: BaseUrl/report/user/date/$date
  • 请求方式: GET

Request请求说明:

路径参数说明(路径中$开头的参数)

名称 类型 是否必须 默认值 说明
date String 日期,格式: yyyy-MM-dd

Header参数说明

名称 类型 是否必须 默认值 说明
token String 接口访问凭据,获取方式请参考获取鉴权token

Response响应说明

成功响应数据格式:

  • 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
        }
    }
}
名称 类型 描述
$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" 

【用户】获取24个小时在线用户数

查询当前时间一天内的在线用户数(10分钟一个点,1个小时六个点)

  • 接口地址: BaseUrl/report/online_user
  • 请求方式: GET

Request请求说明:

Header参数说明

名称 类型 是否必须 默认值 说明
token String 接口访问凭据,获取方式请参考获取鉴权token

Response响应说明

成功响应数据格式:

  • content-type:application/json;charset=utf-8

  • 返回值示例

{
    "code":0,
    "msg":"success",
    "data": {
        "online_statics":{
            "$date":4,
            "$date":5
        }
    }
}
名称 类型 描述
online_statics Json 在线用户统计数据
$date Number key: 毫秒时间戳,value: 在线用户数

请求示例

curl $BaseUrl/report/online_user -H "token: xxx" 
开发者中心 SDK 下载

文档中心搜索

在线
咨询

微信扫一扫

随时联系技术支持

在线
咨询