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

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

Эндпоинт и метод

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

Пример запроса

Параметры

НазваниеТипОбязательныйОписание
filtersОбъект MetricsFilters:heavy_plus_sign:Объект с параметрами фильтрации. Подробнее см. ниже.
period_unitString:heavy_minus_sign:Временной интервал для агрегации аналитических данных — результаты группируются по выбранным периодам (дни, недели, месяцы и т. д.). Возможные значения:
  • day
  • week
  • month (по умолчанию)
  • quarter
  • year
period_typeString:heavy_minus_sign:Анализ данных по продлениям или по дням. Подробное описание см. в разделе Отслеживание по продлениям или по дням. Возможные значения:
  • renewals (по умолчанию)
  • days
value_typeString:heavy_minus_sign:Способ отображения значений. Возможные значения:
  • absolute (по умолчанию): в процентах от общего числа
  • relative: в процентах от начального значения, начиная со 100% для периодов продления
value_fieldString:heavy_minus_sign:Тип отображаемых значений. Возможные значения:
  • revenue (по умолчанию)
  • arppu
  • arpu
  • arpas
  • subscribers
  • subscriptions
accounting_typeString:heavy_minus_sign:Метод учёта. Возможные значения:
  • revenue (по умолчанию)
  • proceeds
  • net_revenue
renewal_daysArray of Integers:heavy_minus_sign:Список дней с момента установки приложения для типа когорты period_type=days. По умолчанию: 0, 3, 7, 14, 28, 31, 61, 92, 183, 336, 550, 731.
prediction_monthsInteger:heavy_minus_sign:Количество месяцев прогноза. Возможные значения: 3, 6, 9, 12 (по умолчанию), 18, 24.
formatString:heavy_minus_sign:Формат экспортируемого файла. Доступные варианты:
  • json (по умолчанию)
  • csv

Объект MetricsFilters

НазваниеТипОбязательныйОписание
datearray of String values(data):heavy_plus_sign:Дата или период, за который нужно получить данные графика.
storearray of String values:heavy_minus_sign:Фильтр по стору, в котором совершена покупка. Возможные значения: app_store, play_store, stripe, а также любой пользовательский ID стора. Для пользовательского стора укажите его ID, заданный в дашборде Adapty.
countryarray of String values:heavy_minus_sign:Фильтр по двухбуквенному коду страны, в которой совершена покупка, по стандарту ISO 3166-1.
store_product_idarray of String values:heavy_minus_sign:Уникальный идентификатор продукта в сторе. Его можно найти в разделе Products дашборда Adapty.
durationarray of String:heavy_minus_sign:Длительность подписки. Возможные значения:
  • Weekly
  • Monthly
  • 2 months
  • 3 months
  • 6 months
  • Annual
  • Lifetime
  • Uncategorized
attribution_sourcearray of String values:heavy_minus_sign:Источник интеграции для атрибуции. Возможные значения:
  • adjust
  • airbridge
  • apple_search_ads
  • appsflyer
  • branch
  • custom
attribution_statusarray of String values:heavy_minus_sign:Органическая или неорганическая атрибуция. Возможные значения:
  • organic
  • non-organic
  • unknown
attribution_channelarray of String values:heavy_minus_sign:Маркетинговый канал, из которого пришла транзакция.
attribution_campaignarray of String values:heavy_minus_sign:Маркетинговая кампания, из которой пришла транзакция.
attribution_adgrouparray of String values:heavy_minus_sign:Рекламная группа атрибуции, из которой пришла транзакция.
attribution_adsetarray of String values:heavy_minus_sign:Рекламный набор атрибуции, из которого пришла транзакция.
attribution_creativearray of String values:heavy_minus_sign:Конкретные визуальные или текстовые элементы объявления или кампании, отслеживаемые для оценки эффективности (например, клики, конверсии).
offer_categoryarray of String values:heavy_minus_sign:Категории офферов, по которым нужно получить данные. Возможные значения:
  • introductory
  • promotional
  • winback
offer_typearray of String values:heavy_minus_sign:Типы офферов, по которым нужно получить данные. Возможные значения:
  • free_trial
  • pay_as_you_go
  • pay_up_front
offer_idarray of String values:heavy_minus_sign:Конкретные офферы, по которым нужно получить данные.