---
description: 方舟4.3.4版本中新增API
---
# 留存分析
## 1. 接口地址
> 【POST】 /uba/api/retentions/analyze
## 2. 请求参数示例
接口请求参数,更多参数说明参照 查询API 中的 [通用参数](./#2-tong-yong-can-shu) 说明。
### 2.1 按属性细分
```java
{
//【必填】初始行为
"firstEvent": {
"expression": "event.$startup"
},
//【必填】回访行为
"secondEvent": {
"expression": "event.$pageview"
},
//按XX维度查看,只支持单个维度,不传表示不按维度细分,这里表示按照平台查看
"byField": {
"expression": "event.$startup.$platform"
},
//按初始/回访行为的属性查看,1表示初始行为 2表示回访行为 -1表示用户属性或无维度
"byFieldIndex": 1,
//【必填】用户分群
"crowds": ["$ALL"],
//【必填】 时间范围-开始时间
"fromDate": "2019-07-17",
//【必填】 时间范围-结束时间
"toDate": "2019-07-19",
//【必填】留存范围,和unit匹配使用,这里表示查询7日留存
"duration": 7,
//【必填】
"unit": "DAY",
//抽样 这里表示全量
"samplingFactor": 1,
//最多返回多少维度记录
"limit": 50,
//使用缓存 这里表示 使用 缓存
"useCache": true
}
```
### 2.2 不细分同时显示其他指标
```java
{
"firstEvent": {
"expression": "event.$startup"
},
"secondEvent": {
"expression": "event.$pageview"
},
//额外查询的指标
"measures": {
"expression": "event.$Anything",
"aggregator": "TRIGGER_USER_COUNT"
},
"crowds": ["$ALL"],
"fromDate": "2019-07-17",
"toDate": "2019-07-19",
"byField": null,
"byFieldIndex": -1
"duration": 7,
"unit": "DAY",
"samplingFactor": 1,
"useCache": true,
"limit": 50
}
```
>[info]**特殊说明:**
1、参数在示例中未标注必填的表示选填。
2、请求参数可以通过方舟产品生成,具体参照 [接口请求参数获取](./#4-jie-kou-qing-qiu-can-shu-kuai-jie-huo-qu)。
3、细分维度只支持单维度查看,并且按维度查看时不能同时查看其他指标,不支持分群对比。
4、measures 指标查询,aggregator参考事件分析 [聚合表达式说明](api-event.md#21-ju-he-biao-da-shi-shuo-ming)。
>
>**认证参数**:接口必传token和appKey两个参数,详情见 [项目接口认证](../README.md)。
****
### 2.3 特殊参数说明
> **duration:**需要查询的留存范围,如支持次日、七日、14日、30日,和 unit 联合使用。
>
> **unit**:查询范围周期单位,目前支持DAY,WEEK,MONTH三种时间单位。
## 3. 返回结果示例
### 3.1 按属性细分
```java
{
//细分维度 平台
"byField": "event.$startup.$platform",
//各个平台的结果
"rows": [
{
//平台值
"byValue": "JS",
//目标用户数(当日)
"totalPeople": 127,
//留存人数 按照索引 依次为当日、第一日、第二日...第七日
"retentionPeoples": [
127,
10,
7,
2,
4,
6,
5,
2
],
"measures": null
},
{
"byValue": "Android",
"totalPeople": 12,
"retentionPeoples": [
12,
0,
1,
1,
0,
0,
0,
0
],
"measures": null
}
],
"reportUpdateTime": "2019-07-24 11:44:31"
}
```
### 3.2 不细分同时显示其他指标
```java
{
//不细分
"byField": null,
//返回总体和每日留存情况,第一条结果为总体,后续为每日详情
"rows": [
{
//总体(这里的总体是各日期汇总去重之后的结果,和页面上展示的总体结果不一致)
"byValue": "$ALL",
//目标用户数
"totalPeople": 139,
//留存人数 按照索引 依次为当日、第一日、第二日...第七日
"retentionPeoples": [
139,
10,
8,
7,
7,
7,
6,
2
],
//留存用户中同时触发指标指标事件和retentionPeoples对应
"measures": [
139,
//第一日留存10人中 其中进行了任意事件触发用户数的有10人
10,
8,
7,
7,
7,
6,
2
]
},
//对应每日留存
{
"byValue": "2019/07/17 00:00:00",
"totalPeople": 29,
"retentionPeoples": [
29,
7,
6,
1,
1,
4,
4,
2
],
"measures": [
29,
7,
6,
1,
1,
4,
4,
2
]
},
{
"byValue": "2019/07/18 00:00:00",
"totalPeople": 100,
"retentionPeoples": [
100,
6,
1,
1,
4,
4,
3,
0
],
"measures": [
100,
6,
1,
1,
4,
4,
3,
0
]
},
{
"byValue": "2019/07/19 00:00:00",
"totalPeople": 22,
"retentionPeoples": [
22,
2,
3,
7,
6,
4,
0,
0
],
"measures": [
22,
2,
3,
7,
6,
4,
0,
0
]
}
],
"reportUpdateTime": "2019-07-24 14:20:28"
}
```
## 4. 接口调用示例
```java
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
"firstEvent": {
"expression": "event.$startup"
},
"secondEvent": {
"expression": "event.$pageview"
},
"measures": {
"expression": "event.$Anything",
"aggregator": "TRIGGER_USER_COUNT"
},
"crowds": ["$ALL"],
"fromDate": "2019-07-17",
"toDate": "2019-07-19",
"byField": null,
"byFieldIndex": -1,
"duration": 7,
"unit": "DAY",
"samplingFactor": 1,
"useCache": true,
"limit": 50
}' http://127.0.0.1:4005/uba/api/retentions/analyze
```
- 产品简介
- 快速上手
- Step 1 安装部署
- Step 2 激活系统创建项目
- Step 3 开启您的分析旅程
- 1. 集成 SDK
- 2. 可视化埋点
- 3. 创建分析模型
- 附:埋点方案设计
- 附:数据分析思路
- 产品更新日志
- V5.5 新增LTV分析功能等
- V5.3 UI 升级、分布分析重构、维度表动态更新、细节优化等
- V5.2 新增归因分析、消息中心、重构埋点方案、优化看数据体验……
- V5.1.0317 体验优化& Bug修复
- V5.1 升级可视化埋点、增强权限控制……
- Part I 产品功能说明
- 名词解释
- 指标说明
- 看板
- 5.3.3 看板 UI 重构
- 分析
- 事件分析
- 渠道分析
- 渠道相关名词解释
- 来源识别规则
- 搜索引擎
- 社交媒体
- 小程序场景值
- Session 分析
- Session 规则
- 实时分析
- 留存分析
- 转化漏斗
- 智能路径
- 归因分析
- 热图分析
- Web/H5 热图
- APP 热图
- 分布分析
- 间隔分析
- 属性分析
- LTV 分析
- 多主体分析
- 自定义查询
- 用户
- 用户分群
- 用户探查
- 用户标签
- 标签体系应用概览
- 标签体系
- 标签生命周期管理
- 标签加工
- 如何自定义SQL创建标签
- 单用户档案
- 运营
- 广告跟踪
- 微信小程序渠道追踪
- 预置广告媒介和渠道
- App 推广监测(Beta版本)
- 电子邮件(即将下线)
- 短信(即将下线)
- 消息通知(即将下线)
- 项目管理
- 项目概览
- 项目角色管理
- 项目成员管理
- 数据接入管理
- 埋点方案
- 可视化埋点
- 集成SDK接入数据
- 数据验证
- 用户数据导入
- 微信小程序全埋点事件定义
- 元数据管理
- 元事件
- 虚拟事件
- 事件属性
- 用户属性
- Session 管理
- 页面组管理
- 维度表
- 服务集成配置
- 监控告警
- 智能监控
- 自定义监控
- 平台管理
- 企业概览
- 项目管理
- 成员管理
- 安全设置
- 企业设置
- 日志管理
- 帐号设置
- Part II 技术文档
- 技术接入准备工作
- 部署环境检测工具
- 数据模型
- 数据格式
- 预置事件和属性
- App预置事件/属性
- JS 预置事件/属性
- 如何准确识别用户
- 如何设计埋点方案
- 分平台上报数据 vs 跨平台打通
- SDK 指南
- Android SDK
- 快速集成
- 全埋点模块
- 消息推送模块
- Android Hybrid模式
- SDK Gradle集成方式
- 多渠道打包
- 易观小工具
- 合规相关
- iOS SDK
- 快速集成
- 全埋点介绍
- iOS Hybrid模式
- 消息推送模块
- JS SDK
- 快速集成
- JS SDK基础版
- JS SDK插件
- uni-app SDK
- 快速集成
- 打包原生APP
- 开启移动端全埋点
- uni-app SDK标准版
- 微信小程序 SDK
- 快速集成
- 微信小程序标准版
- 微信小程序插件版
- 微信小程序通用框架版
- 支付宝小程序 SDK
- 支付宝小程序标准版
- 支付宝小程序通用框架版
- 字节跳动小程序 SDK
- 字节跳动小程序标准版
- 字节跳动小程序通用框架版
- 百度小程序 SDK
- 百度小程序标准版
- 百度小程序通用框架版
- 钉钉小程序 SDK
- 钉钉小程序标准版
- 钉钉小程序通用框架版
- QQ小程序 SDK
- QQ小程序标准版
- QQ小程序通用框架版
- 快应用 SDK
- 华为WeCode小程序
- WeCode SDK 标准版
- WeCode SDK插件
- PhoneGap SDK
- mPaaS SDK
- ReactNative SDK
- Flutter SDK
- Java SDK
- Python SDK
- PHP SDK
- C++ SDK
- C# SDK
- Node JS SDK
- Lua SDK
- Golang SDK
- SDK FAQ
- identify与alias的区别
- 爬虫数据如何识别?
- 页面停留如何获取时间?
- 如果获取SDK及更新日志
- 代码埋点和无埋点有什么区别
- Web页面中发现丢失某一个事件
- 自研 SDK 注意事项
- 页面时长统计功能
- 飞书小程序 SDK
- 飞书小程序标准版
- 飞书小程序通用框架版
- Unreal Engine SDK
- 数据验证
- 客户端埋点验证
- Debug 数据验证
- 数据入库验证
- 数据导入
- 接口导入
- JAVA工具包
- 标准json文件导入
- csv格式导入
- 数据导入FAQ
- 数据导出
- JAVA工具包
- 事件数据导出
- 用户数据导出
- 直接从Kafka中消费数据
- 使用程序访问数据库
- 脚本工具
- API
- 分析API
- 事件分析
- 留存分析
- 自定义查询
- 转化漏斗
- 属性分析
- Session分析
- 渠道分析
- 分布分析
- 用户API
- 分群查询
- 用户档案
- 分群管理
- 管理API
- 权限管理
- 元数据管理
- 埋点方案管理
- 维度表管理
- 运营API
- 广告跟踪
- APP推广监测
- 平台管理API
- 项目管理
- 成员管理
- 第三方登录
- OAuth2.0登录
- LDAP登录
- GDPR 合规
- Part III 常见问题
- License 许可
- 产品试用及采购
- 参与贡献