> For the complete documentation index, see [llms.txt](https://growingio.gitbook.io/v3/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://growingio.gitbook.io/v3/developer-manual/api-reference/statistics-api-v3/definition/getretention.md).

# 获取留存分析数据

## URL <a href="#url" id="url"></a>

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

## 请求类型 <a href="#qing-qiu-lei-xing" id="qing-qiu-lei-xing"></a>

GET

## 结果返回方式 <a href="#qing-qiu-lei-xing" id="qing-qiu-lei-xing"></a>

异步：参考 [概述](/v3/developer-manual/api-reference/statistics-api-v3/overview.md) 部分的描述

## 请求头参数 <a href="#qing-qiu-tou-can-shu" id="qing-qiu-tou-can-shu"></a>

公共头部请参考[公共请求头参数](/v3/developer-manual/api-reference/authenticate.md)。

## 参数说明与示例 <a href="#can-shu-shuo-ming-yu-shi-li" id="can-shu-shuo-ming-yu-shi-li"></a>

{% tabs %}
{% tab title="请求参数" %}

| 路径参数          | 类型     | 是否必传 | 说明                                                                                                                                  |
| ------------- | ------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------- |
| retention\_id | string | 是    | <p>留存分析单图ID</p><p>详细请参考： <a href="/v3/developer-manual/api-reference/statistics-api/definition/get-chartinfo.md">获取看板中的图表信息</a></p> |
| project\_uid  | string | 是    | 项目UID，详细请参考 [获取项目UID](/v3/product-manual/projectmange/projectmange/get-uid.md)                                                      |

| 查询参数 | 类型 | 是否必传 | 说明 |
| ---- | -- | ---- | -- |

| range | string | 否 | <p>事件范围。</p><ul><li>day（日留存）</li><li>week（周留存）</li><li>month（月留存）</li></ul> |
| ----- | ------ | - | --------------------------------------------------------------------------- |

| startTime | integer | 否 | <p>数据起始时间，unix毫秒时间戳。</p><p>需与endTime一起使用。</p> |
| --------- | ------- | - | --------------------------------------------- |

| endTime      | integer | 否 | <p>数据结束时间，unix毫秒时间戳。</p><p>需与startTime一起使用。</p> |
| ------------ | ------- | - | ----------------------------------------------- |
| {% endtab %} |         |   |                                                 |

{% tab title="响应示例" %}
导出未完成：

```
{"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日后留存]
    ]
}
```

{% endtab %}
{% endtabs %}