获取留存分析数据

URL

https://www.growingio.com/v3/exporter/projects/{project_uid}/retentions/{retention_id}

请求类型

GET

结果返回方式

异步：参考 概述 部分的描述

请求头参数

公共头部请参考公共请求头参数。

参数说明与示例

请求参数

路径参数	类型	是否必传	说明
retention_id	string	是	留存分析单图ID 详细请参考： 获取看板中的图表信息
project_uid	string	是	项目UID，详细请参考 获取项目UID

查询参数

类型

是否必传

说明

range

string

否

事件范围。 day（日留存） week（周留存） month（月留存）

startTime

integer

否

数据起始时间，unix毫秒时间戳。 需与endTime一起使用。

endTime

integer

否

数据结束时间，unix毫秒时间戳。 需与startTime一起使用。

响应示例

导出未完成：

{"id":"随机ID","status":"doing"}

导出完成：

{
    "id":  "Retention Uid",
    "name":  "Retention Name",
    "range":  "day",
    "startTime":  1569686400000,
    "endTime":  1572278399999,
    "interval":  86400000,
    "meta":  [
        {"name":"目标用户","dimension":true},
        {"name":"对比值","dimension":true},
        {"name":"用户行为","dimension":true},
        {"name":"时间","dimension":true},
        {"name":"留存人数","metric":true},
        {"name":"当日","metric":true},
        {"name":"当日留存率","metric":true},
        {"name":"次日","metric":true},
        {"name":"次日留存率","metric":true},
        {"name":"2日后","metric":true},
        {"name":"2日后留存率","metric":true},
        . . .
        {"name":"29日后","metric":true},
        {"name":"29日后留存率","metric":true}
    ],
    "data":  [
        [目标用户,对比值,用户行为,时间,留存,...,29日后留存],
        . . .,
        [目标用户,对比值,用户行为,时间,留存,...,29日后留存]
    ]
}