POST管理接口
留存分析
按「首次命中起始事件」的当地周期把用户分成队列,统计其后各周期的回访比例。 `return_event` 不传则任意事件都算回访。 尚未走完的周期返回 `null` 而不是 0:把还没发生的时间显示成 0% 留存是不诚实的。 只读接口,用 POST 的理由同漏斗;所需权限是 events:read。
URL
/api/v1/admin/projects/{projectKey}/events/analysis/retention鉴权方式
需要管理员 JWT 或 API Key,二者等价(Authorization: Bearer <token>)
请求参数
Path 参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| projectKey | string | 是 | 项目主键 project_key(大小写不敏感) |
Header 参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| Authorization | string | 是 | Bearer <管理员 JWT 或 API Key> |
请求体
{
"start_event": "app_installed",
"return_event": "app_opened",
"period": "day",
"periods": 14
}响应示例
200 响应
{
"start_time": 0,
"end_time": 0,
"period": "day",
"periods": 0,
"cohorts": [
{
"cohort": 0,
"size": 0,
"cells": [
{
"period": 0,
"users": 0,
"rate": 0
}
]
}
]
}POST
