Получение данных когорт
Получайте данные когорт для отслеживания групп пользователей во времени.
Эндпоинт и метод
POST https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/
Пример запроса
Параметры
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
| filters | Объект MetricsFilters | :heavy_plus_sign: | Объект с параметрами фильтрации. Подробнее см. ниже. |
| period_unit | String | :heavy_minus_sign: | Временной интервал для агрегации аналитических данных — результаты группируются по выбранным периодам (дни, недели, месяцы и т. д.). Возможные значения:
|
| period_type | String | :heavy_minus_sign: | Анализ данных по продлениям или по дням. Подробное описание см. в разделе Отслеживание по продлениям или по дням. Возможные значения:
|
| value_type | String | :heavy_minus_sign: | Способ отображения значений. Возможные значения:
|
| value_field | String | :heavy_minus_sign: | Тип отображаемых значений. Возможные значения:
|
| accounting_type | String | :heavy_minus_sign: | Метод учёта. Возможные значения:
|
| 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: | Формат экспортируемого файла. Доступные варианты:
|
Объект MetricsFilters
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
| 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 дашборда Adapty. |
| duration | array of String | :heavy_minus_sign: | Длительность подписки. Возможные значения:
|
| attribution_source | array of String values | :heavy_minus_sign: | Источник интеграции для атрибуции. Возможные значения:
|
| attribution_status | array of String values | :heavy_minus_sign: | Органическая или неорганическая атрибуция. Возможные значения:
|
| 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: | Категории офферов, по которым нужно получить данные. Возможные значения:
|
| offer_type | array of String values | :heavy_minus_sign: | Типы офферов, по которым нужно получить данные. Возможные значения:
|
| offer_id | array of String values | :heavy_minus_sign: | Конкретные офферы, по которым нужно получить данные. |