统计API

简述

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

【推送】获取推送结果（不含自定义事件）

查询推送数据，可查询近 90 天内的数据。返回结果包括：可下发数、下发数，接收数、展示数、点击数等结果。支持单个taskId查询和多个taskId查询。
此接口调用，仅可以查询toList或toApp的推送结果数据；不能查询toSingle的推送结果数据。

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

【推送】获取推送结果（含自定义事件）

查询推送数据，可查询近 90 天内的数据。返回结果包括：可下发数、下发数，接收数、展示数、点击数等结果。支持单个taskId查询和多个taskId查询。
此接口调用，仅可以查询toList或toApp的推送结果数据；不能查询toSingle的推送结果数据。

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

Request请求说明:

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

Header参数说明

Query参数说明

个推在线通道报表区分品牌数据，可明确知晓各品牌设备的推送数据流，且有助于评估个推通道缓解厂商通道限额的效果。

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
            }
        }
    }
}

• 返回结构说明请参考公共返回结构

• 返回参数data说明

请求示例

curl $BaseUrl/report/push/task/$taskid,$taskid -H "token: xxx" 

【推送】任务组名查报表

根据任务组名查询推送结果，可查询近 90 天内的数据。返回结果包括：消息可下发数、下发数，接收数、展示数、点击数。

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

Request请求说明:

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

Query参数说明

Header参数说明

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
            }
        }
    }
}

• 返回结构说明请参考公共返回结构

• 返回参数data说明

请求示例

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

【推送】获取推送实时结果

获取推送实时结果，可查询消息下发数，接收数、展示数、点击数和消息折损详情等结果。支持单个taskId查询和多个taskId查询。

注意：该接口需要开通权限，如需开通，请联系对应的商务同学开通

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

Request请求说明:

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

Header参数说明

Response响应说明

成功响应数据格式:

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

• 返回值示例

{
    "msg":"success",
    "code":0,
    "data":{
        "$taskid":{
            "total":{
                "msg_num":320,
                "target_num":14,
                "receive_num":3,
                "display_num":3,
                "click_num":0
            },
            "gt":{
                "target_num":3,
                "receive_num":2,
                "display_num":2,
                "click_num":0
            },
            "apn":{
                "target_num":11,
                "receive_num":1,
                "display_num":1,
                "click_num":0
            },
            "failed_detail":{
                "rs":{
                    "gt":{
                        "12":{
                            "total":231
                        }
                    },
                    "apn":{
                        "11":{
                            "11999":1,
                            "total":1
                        }
                    }
                },
                "ts":{
                    "gt":{
                        "13":{
                            "13001":608,
                            "total":608
                        },
                        "14":{
                            "14001":3,
                            "total":3
                        }
                    }
                }
            }
        }
    }
}

• 返回结构说明请参考公共返回结构

• 返回参数data说明

• ts/rs/sf/fd 里面的各个通道下面的数据含义

折损详情分类如下，2-14是折损大类说明，大类说明下面的2001-14006是细分的折损原因，total代表各细分原因总和

请求示例

curl $BaseUrl/report/push/task/${taskid}/detail -H "token: xxx" 

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

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

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

Request请求说明:

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

Query参数说明

Header参数说明

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
            },
             "ho": {
                "target_num":2,
                "receive_num":2,
                "display_num":1,
                "click_num":1
            }            
        }
    }
}

• 返回结构说明请参考公共返回结构

• 返回参数data说明

请求示例

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参数说明

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
            }
        }
    }
}

• 返回结构说明请参考公共返回结构

• 返回参数data说明

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

请求示例

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

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

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

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

Request请求说明:

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

Header参数说明

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
        }
    }
}

• 返回结构说明请参考公共返回结构

• 返回参数data说明

请求示例

curl $BaseUrl/report/user/date/$date -H "token: xxx" 

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

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

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

Request请求说明:

Header参数说明

Response响应说明

成功响应数据格式:

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

• 返回值示例

{
    "code":0,
    "msg":"success",
    "data": {
        "online_statics":{
            "$date":4,
            "$date":5
        }
    }
}

• 返回结构说明请参考公共返回结构

• 返回参数data说明

请求示例

curl $BaseUrl/report/online_user -H "token: xxx"