导航|地址|刷新
统计 API-个推文档中心











文档中心开发者中心

，欢迎您！

您的优惠服务将于到期。





基本资料



安全设置



应用管理




退出登录
登录/注册SDK下载个推学堂请选择产品
消息推送

用户运营

OneID服务

AI应用工坊

统计分析

用户分析

标签管理

模型管理

短信服务

数字人外呼

一键认证

合规检测

点击提升







体验更多产品服务


欢迎登录开发者中心

立即登录

本月不再提醒





产品简介

产品使用手册
生命周期
概览

价值用户挖掘

沉默用户促活

流失用户预测

卸载原因分析


埋点行为数据采集和管理

数据统计分析和洞察

用户分层打标和群体扩量

场景模板
场景运营介绍


运营计划

用户群管理

数据管理

权限管理

流程画布

AI助手
ChatBI智能问数


Webhook
业务介绍

技术对接说明



应用场景
埋点应用场景案例


服务端
RestAPI
开发须知

接口调用规范

鉴权API

标签API

用户API

统计API

公共参数

返回码说明



客户端
Android
集成文档

API文档

使用文档

SDK集成视频


iOS
集成文档

API文档

使用文档

隐私清单说明


HarmonyOS
集成文档

API接口

使用文档


H5&小程序
集成文档

API文档


客户端插件

SDK更新日志


常见问题




当前位置：用户运营 > 服务端 > RestAPI > 统计API



统计 API


统计 API

简述

开发者可以通过以下接口导出系统基础看板数据。


【实时】今日用户活跃、启动、新增数据导出

开发者可以通过该接口获取应用今日用户活跃、启动、新增数据。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。


数据示例图



接口定义

接口地址: $BaseUrl/export/todayStatistics

请求方式: POST

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

Request请求说明

Header参数说明

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

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
foregroundFlag	String	否	1	计算基准，0：前后台，1：前台

入参示例
{ "foregroundFlag": "0" }
Response响应说明

http code: 200(http code码说明)

正常响应出参示例
{ "data": { "list": [ { "dimension": "total", // 平台展示维度，包含total、android、ios等维度"statisticsData": { // 统计数据"install": { // 今日新增"cnt": 156902, // 今日新增用户数"ytdPercent": "11.11", // 前一日"sevenPercent": "11.12"// 前七日 }, "active": { // 今日活跃"cnt": 89891, // 今日活跃用户数"sevenPercent": "22.11", // 前一日"ytdPercent": "-22.22"// 前七日 }, "start": { // 今日启动"cnt": 988, // 今日启动用户数"sevenPercent": "-22.1", // 前一日"ytdPercent": "34.5"// 前七日 } } } ] }, "code": 0, // 响应code码"msg": "成功"// 响应信息 }
请求示例
curl $BaseUrl/export/todayStatistics \ -X POST \ -H "Content-Type: application/json;charset=utf-8"\ -H "token: $token"\ -d '{"foregroundFlag": "0"}'
【实时】分时段用户活跃、启动、新增数据导出

开发者可以通过该接口获取应用分时段用户活跃、启动、新增数据。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。


数据示例图



接口定义

接口地址: $BaseUrl/export/periodChart

请求方式: POST

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

Request请求说明

Header参数说明

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

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
analyzeType	Byte	是	无	分析类型，0：新增，1：活跃，2：启动
aggregatorType	Byte	否	无	聚合类型，1表示平台，2表示渠道，3表示版本，4表示包名，默认只返回汇总数据
aggregatorValue	String	否	无	聚合值，为空表示获取所有当前聚合类型的数据，否则按照聚合值过滤筛选
foregroundFlag	String	否	1	计算基准，0：前后台，1：前台

入参示例
{ "analyzeType": 0, "foregroundFlag": "0" }
Response响应说明

http code: 200(http code码说明)

正常响应出参示例
{ "code": 0, // 响应code码"msg": "成功", // 响应信息"data": { "list": [ { "dimension": "total", // 平台展示维度，包含total、android、ios等维度"statisticsData": { "itemName": "活跃用户数据", // 指标项名称"todayData": [ // 今日数据 { "time": "00:00:00", // 日期"value": "127"// 数量 } ], "yesterdayData": [ // 昨日数据 { "time": "00:00:00", "value": "119" } ], "sevenDayData": [ // 七日数据 { "time": "00:00:00", "value": "125" } ] } } ] } }
请求示例
curl $BaseUrl/export/periodChart \ -X POST \ -H "Content-Type: application/json;charset=utf-8"\ -H "token: $token"\ -d '{ "analyzeType": 0, "foregroundFlag": "0" }'
【实时】昨日日活、周活、月活、DAU/MAU数据导出

开发者可以通过该接口获取应用昨日日活、周活、月活、DAU/MAU数据，支持按照用户指定维度展示。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。


数据示例图



接口定义

接口地址: $BaseUrl/export/activityStatistics

请求方式: POST

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

Request请求说明

Header参数说明

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

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
channels	String	否	无	渠道信息，默认查询全部渠道，多个渠道用逗号分隔
appVersions	String	否	无	版本信息，默认查询所有版本，多个版本用逗号分隔
packageNames	String	否	无	包名信息，默认查询所有包名，多个包名用逗号分隔
platforms	String	否	无	平台信息，默认查询所有平台，多个平台用逗号分隔
foregroundFlag	String	否	1	计算基准，0：前后台，1：前台
aggregatorType	Byte	否	无	聚合类型，1表示平台，2表示渠道，3表示版本，4表示包名，默认只返回汇总数据

入参示例
{ "channels": "渠道1,渠道2", "appVersions": "版本1,版本2", "packageNames": "包名1,包名2", "platforms": "android,ios", "aggregatorType": 1, "foregroundFlag": "0" }
Response响应说明

http code: 200(http code码说明)

正常响应出参示例
{ "code": 0, // 响应code码"msg": "成功", // 响应信息"data": { "list": [ { "dimension": "total", // 展示维度，如果聚合类型为包名，则返回total，包名1，包名2等维度数据；如果是版本，则返回total，版本1，版本2等维度数据，以此类推"statisticsData": { // 统计数据"ytd": { // 昨日日活数据"total": 100, // 昨日日活数量"mom": "0.3500"// 环比 }, "mau": { // mau"total": "0.2511", // mau占比"mom": "0.3500"// 环比 }, "month": { // 月活数据"total": 100, // 月活数量"mom": "0.3500"// 环比 }, "week": { // 周活数据"total": 100, // 周活数量"mom": "0.3500"// 环比 } } }, { "dimension": "包名1", "statisticsData": { // 统计数据"ytd": { // 昨日日活数据"total": 100, // 昨日日活数量"mom": "0.3500"// 环比 }, "mau": { // mau"total": "0.2511", // mau占比"mom": "0.3500"// 环比 }, "month": { // 月活数据"total": 100, // 月活数量"mom": "0.3500"// 环比 }, "week": { // 周活数据"total": 100, // 周活数量"mom": "0.3500"// 环比 } } } ] } }
请求示例
curl $BaseUrl/export/activityStatistics \ -X POST \ -H "Content-Type: application/json;charset=utf-8" \ -H "token: $token" \ -d '{ "channels": "渠道1", "appVersions": "版本1", "packageNames": "包名2", "platforms": "android,ios", "aggregatorType": 1, "foregroundFlag": "0" }'
【实时】用户整体趋势图表数据导出

开发者可以通过该接口获取应用趋势图数据，包含新增、活跃、启动、累计用户数、人均使用时长以及人均使用频次统计数据，支持按照用户指定维度展示。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。


数据示例图



接口定义

接口地址: $BaseUrl/export/userTrendChart

请求方式: POST

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

Request请求说明

Header参数说明

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

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
channels	String	否	无	渠道信息，默认查询全部渠道，多个渠道用逗号分隔
appVersions	String	否	无	版本信息，默认查询所有版本，多个版本用逗号分隔
packageNames	String	否	无	包名信息，默认查询所有包名，多个包名用逗号分隔
platforms	String	否	无	平台信息，默认查询所有平台，多个平台用逗号分隔
startDate	String	是	无	开始时间，yyyy-MM-dd格式，仅支持最近一年内数据查询
endDate	String	是	无	结束时间，yyyy-MM-dd格式，距开始时间不能超过90天
analyzeType	Byte	是	无	分析类型，0表示新增，1表示活跃，2表示启动，3表示累计，4表示人均使用时长，5表示人均使用频次
aggregatorType	Byte	否	无	聚合类型，1表示平台，2表示渠道，3表示版本，4表示包名，默认只返回汇总数据
foregroundFlag	String	否	1	计算基准，0：前后台，1：前台

入参示例
{ "channels": "渠道1,渠道2", "appVersions": "版本1,版本2", "packageNames": "包名1,包名2", "platforms": "android,ios", "analyzeType": 0, "startDate":"2022-05-01", "endDate":"2022-06-01", "aggregatorType": 1, "foregroundFlag": "0" }
Response响应说明

http code: 200(http code码说明)

正常响应出参示例
{ "code":0, // 响应code码"msg":"成功", // 响应信息"data":{ "list":[ { "dimension":"total", // 展示维度，如果聚合类型为包名，则返回total，包名1，包名2等维度数据；如果是版本，则返回total，版本1，版本2等维度数据，以此类推"statisticsDataList":[ // 统计数据列表 { "time":"2022-05-01", // 时间"value":"127"// 对应时间的数据 }, { "time":"2022-05-02", "value":"50" } ] } ] } }
请求示例
curl $BaseUrl/export/userTrendChart \ -X POST \ -H "Content-Type: application/json;charset=utf-8" \ -H "token: $token" -d '{ "channels": "渠道1,渠道2", "appVersions": "版本1,版本2", "packageNames": "包名1,包名2", "platforms": "android,ios", "analyzeType": 0, "startDate":"2022-05-01", "endDate":"2022-06-01", "aggregatorType": "1", "foregroundFlag": "0" }'
【实时】新增、活跃次日、七日留存趋势图数据导出

开发者可以通过该接口获取应用留存趋势图数据，包含新增、活跃次日、七日统计数据，支持按照用户指定维度展示。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。


数据示例图



接口定义

接口地址: $BaseUrl/export/remainChart

请求方式: POST

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

Request请求说明

Header参数说明

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

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
channels	String	否	无	渠道信息，默认查询全部渠道，多个渠道用逗号分隔
appVersions	String	否	无	版本信息，默认查询所有版本，多个版本用逗号分隔
packageNames	String	否	无	包名信息，默认查询所有包名，多个包名用逗号分隔
platforms	String	否	无	平台信息，默认查询所有平台，多个平台用逗号分隔
startDate	String	是	无	开始时间，yyyy-MM-dd格式，仅支持最近一年内数据查询
endDate	String	是	无	结束时间，yyyy-MM-dd格式，距开始时间不能超过90天
analyzeType	Integer	是	无	分析类型，0表示新增，1表示活跃，2表示启动
aggregatorType	Byte	否	无	聚合类型，1表示平台，2表示渠道，3表示版本，4表示包名，默认只返回汇总数据
foregroundFlag	String	否	1	计算基准，0：前后台，1：前台

入参示例
{ "channels": "渠道1,渠道2", "appVersions": "版本1,版本2", "packageNames": "包名1,包名2", "platforms": "android,ios", "analyzeType": 0, "startDate":"2022-05-01", "endDate":"2022-06-01", "aggregatorType": 1, "foregroundFlag": "0" }
Response响应说明

http code: 200(http code码说明)

正常响应出参示例
{ "data":{ "list":[ { "dimension":"total", // 展示维度，如果聚合类型为包名，则返回total，包名1，包名2等维度数据；如果是版本，则返回total，版本1，版本2等维度数据，以此类推"statisticsData":{ // 统计数据"date":"2022-05-24", // 时间"userCount":83852, // 用户数量"yesterdayPercent":31.95, // 昨日留存率"twoDayPercent":26.34, // 前日留存率"threeDayPercent":21.36, // 三日留存率"fourDayPercent":28.44, // 四日留存率"fiveDayPercent":24.46, // 五日留存率"sixDayPercent":26.39, // 六日留存率"sevenDayPercent":14.27, // 七日留存率"thirtyDayPercent":0// 三十日留存率 } }, { "dimension":"包名1", "statisticsData":{ "date":"2022-05-24", "userCount":83852, "yesterdayPercent":31.95, "twoDayPercent":26.34, "threeDayPercent":21.36, "fourDayPercent":28.44, "fiveDayPercent":24.46, "sixDayPercent":26.39, "sevenDayPercent":14.27, "thirtyDayPercent":0 } } ] }, "code":0, "msg":"成功" }
请求示例
curl $BaseUrl/export/remainChart \ -X POST \ -H "Content-Type: application/json;charset=utf-8" \ -H "token: $token" -d '{ "channels": "渠道1,渠道2", "appVersions": "版本1,版本2", "packageNames": "包名1,包名2", "platforms": "android,ios", "analyzeType": 0, "startDate":"2022-05-01", "endDate":"2022-06-01", "aggregatorType": 1, "foregroundFlag": "0" }'



以上文档对您是否有帮助？
有帮助没帮助



您的改进建议

是否遇到以下问题

问题类型


1、内容与功能不一致；

2、文章描述不清晰；

3、图片和视频难理解；

4、对产品功能不满意；

5、不是我想要的内容；

6、其他:


问题类型不能为空



反馈建议



联系方式



取 消提 交





反馈成功

非常感谢您的反馈，我们会继续努力做到更好！
确定






在这篇文章中：简述【实时】今日用户活跃、启动、新增数据导出【实时】分时段用户活跃、启动、新增数据导出【实时】昨日日活、周活、月活、DAU/MAU数据导出【实时】用户整体趋势图表数据导出【实时】新增、活跃次日、七日留存趋势图数据导出







文档中心搜索

搜 索















------
导航页 打开网址