---
title: Получение данных когорт
---

 import MetricsFilters from '@site/src/locales/ru/reusable/MetricsFilters.md';

Получайте данные когорт для отслеживания групп пользователей во времени.

## Эндпоинт и метод \{#endpoint-and-method\}

```http
POST https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/
```

## Пример запроса \{#request-example\}

<Tabs groupId="api-lang" queryString>  

<TabItem value="curl" label="cURL" default>  

```bash
curl --location 'https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/' \
--header 'Authorization: Api-Key <YOUR_SECRET_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "filters": {
    "date": [
      "2024-04-01",
      "2024-09-30"
    ],
    "store": [
      "app_store"
    ],
    "country": [
      "us"
    ]
  },
  "period_unit": "month",
  "period_type": "renewals",
  "value_type": "absolute",
  "value_field": "subscriptions"
}'
```

</TabItem>  

<TabItem value="python" label="Python" default>

  ```python  showLineNumbers

url = "https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/"

payload = json.dumps({
  "filters": {
    "date": [
      "2024-04-01",
      "2024-09-30"
    ],
    "store": [
      "app_store"
    ],
    "country": [
      "us"
    ]
  },
  "period_unit": "month",
  "period_type": "renewals",
  "value_type": "absolute",
  "value_field": "subscriptions"
})
headers = {
  'Authorization': "Api-Key <YOUR_SECRET_API_KEY>",
  'Content-Type': "application/json"
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
  ```

</TabItem>  

<TabItem value="js" label="JavaScript" default>

  ```javascript  showLineNumbers
const myHeaders = new Headers();
myHeaders.append("Authorization", "Api-Key <YOUR_SECRET_API_KEY>");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "filters": {
    "date": [
      "2024-04-01",
      "2024-09-30"
    ],
    "store": [
      "app_store"
    ],
    "country": [
      "us"
    ]
  },
  "period_unit": "month",
  "period_type": "renewals",
  "value_type": "absolute",
  "value_field": "subscriptions"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
  ```

</TabItem>  

</Tabs>

## Параметры \{#parameters\}

| Название          | Тип                                                          | Обязательный       | Описание                                                     |
| ----------------- | ------------------------------------------------------------ | ------------------ | ------------------------------------------------------------ |
| filters           | Объект [MetricsFilters](controls-filters-grouping-compare-proceeds#filtering-and-grouping) | :heavy_plus_sign:  | Объект с параметрами фильтрации. Подробнее см. ниже.         |
| period_unit       | String                                                       | :heavy_minus_sign: | Временной интервал для агрегации аналитических данных — результаты группируются по выбранным периодам (дни, недели, месяцы и т. д.). Возможные значения: <ul><li>day</li><li>week</li><li>month (по умолчанию)</li><li>quarter</li><li>year</li></ul> |
| period_type       | String                                                       | :heavy_minus_sign: | Анализ данных по продлениям или по дням. Подробное описание см. в разделе [Отслеживание по продлениям или по дням](analytics-cohorts#cohorts-by-renewals-or-by-days). Возможные значения: <ul><li>renewals (по умолчанию)</li><li>days</li></ul> |
| value_type        | String                                                       | :heavy_minus_sign: | Способ отображения значений. Возможные значения: <ul><li> absolute (по умолчанию): в процентах от общего числа</li><li> relative: в процентах от начального значения, начиная со 100% для периодов продления</li></ul> |
| value_field       | String                                                       | :heavy_minus_sign: | Тип отображаемых значений. Возможные значения: <ul><li> revenue (по умолчанию)</li><li> arppu</li><li> arpu</li><li> arpas</li><li> subscribers</li><li> subscriptions</li></ul> |
| accounting_type   | String                                                       | :heavy_minus_sign: | Метод учёта. Возможные значения: <ul><li> revenue (по умолчанию)</li><li> proceeds</li><li> net_revenue</li></ul> |
| renewal_days      | Array of Integers                                            | :heavy_minus_sign: | Список дней с момента установки приложения для типа когорты `period_type=days`. По умолчанию: 0, 3, 7, 14, 28, 31, 61, 92, 183, 336, 550, 731. |
| prediction_months | Integer                                                      | :heavy_minus_sign: | Количество месяцев прогноза. Возможные значения: 3, 6, 9, 12 (по умолчанию), 18, 24. |
| format            | String                                                       | :heavy_minus_sign: | Формат экспортируемого файла. Доступные варианты: <ul><li> json (по умолчанию)</li><li> csv</li></ul> |

### Объект MetricsFilters \{#metricsfilters-object\}

| Название             | Тип                          | Обязательный       | Описание                                                     |
| -------------------- | ---------------------------- | ------------------ | ------------------------------------------------------------ |
| date                 | array of String values(data) | :heavy_plus_sign:  | Дата или период, за который нужно получить данные графика.   |
| store                | array of String values       | :heavy_minus_sign: | Фильтр по стору, в котором совершена покупка. Возможные значения: app_store, play_store, stripe, а также любой пользовательский ID стора. Для пользовательского стора укажите его ID, заданный в дашборде Adapty. |
| country              | array of String values       | :heavy_minus_sign: | Фильтр по двухбуквенному коду страны, в которой совершена покупка, по стандарту ISO 3166-1. |
| store_product_id     | array of String values       | :heavy_minus_sign: | Уникальный идентификатор продукта в сторе. Его можно найти в разделе [Products](https://app.adapty.io/products) дашборда Adapty. |
| duration             | array of String              | :heavy_minus_sign: | Длительность подписки. Возможные значения: <ul><li>Weekly</li><li>Monthly</li><li>2 months</li><li>3 months</li><li>6 months</li><li>Annual</li><li>Lifetime</li><li>Uncategorized</li></ul> |
| attribution_source   | array of String values       | :heavy_minus_sign: | Источник интеграции для атрибуции. Возможные значения: <ul><li> adjust</li><li> airbridge</li><li> apple_search_ads</li><li> appsflyer</li><li> branch</li><li> custom</li></ul> |
| attribution_status   | array of String values       | :heavy_minus_sign: | Органическая или неорганическая атрибуция. Возможные значения: <ul><li> organic</li><li> non-organic</li><li> unknown</li></ul> |
| attribution_channel  | array of String values       | :heavy_minus_sign: | Маркетинговый канал, из которого пришла транзакция.          |
| attribution_campaign | array of String values       | :heavy_minus_sign: | Маркетинговая кампания, из которой пришла транзакция.        |
| attribution_adgroup  | array of String values       | :heavy_minus_sign: | Рекламная группа атрибуции, из которой пришла транзакция.    |
| attribution_adset    | array of String values       | :heavy_minus_sign: | Рекламный набор атрибуции, из которого пришла транзакция.    |
| attribution_creative | array of String values       | :heavy_minus_sign: | Конкретные визуальные или текстовые элементы объявления или кампании, отслеживаемые для оценки эффективности (например, клики, конверсии). |
| offer_category       | array of String values       | :heavy_minus_sign: | Категории офферов, по которым нужно получить данные. Возможные значения: <ul><li> introductory</li><li> promotional</li><li> winback</li></ul> |
| offer_type           | array of String values       | :heavy_minus_sign: | Типы офферов, по которым нужно получить данные. Возможные значения: <ul><li> free_trial</li><li> pay_as_you_go</li><li> pay_up_front</li></ul> |
| offer_id             | array of String values       | :heavy_minus_sign: | Конкретные офферы, по которым нужно получить данные.         |