English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v1/client-api/metrics/retention/

Получить данные об удержании

Copy as Markdown

Возвращает данные об удержании для анализа способности продукта удерживать пользователей вовлечёнными с течением времени.

Ограничение по частоте запросов: 2 запроса в секунду.

Request body

filtersobjectrequired
datearray of stringrequired

Укажите дату или период времени, за который вы хотите получить данные графика

compare_datearray of string

Укажите дату или период времени для сравнения

storearray of string

Фильтр по стору, в котором была совершена покупка

countryarray of string

Фильтр по двухбуквенному коду страны, в которой была совершена покупка

store_product_idarray of string

Идентификатор продукта с указанием стора в формате <store>:<product_id> — например, app_store:premium_monthly или play_store:premium_sub:monthly-base-plan для подписки Google с базовым планом. Идентификатор продукта без префикса стора не принимается.

durationarray of string

Укажите длительность подписки

attribution_sourcearray of string

Исходная интеграция для атрибуции

attribution_statusarray of string

Указывает, является ли атрибуция органической или неорганической

attribution_channelarray of string

Маркетинговый канал, который привёл к транзакции

attribution_campaignarray of string

Маркетинговая кампания, которая привела к транзакции

attribution_adgrouparray of string

Группа объявлений атрибуции, которая привела к транзакции

attribution_adsetarray of string

Набор объявлений атрибуции, который привёл к транзакции

attribution_creativearray of string

Конкретные визуальные или текстовые элементы объявления или кампании, отслеживаемые для оценки эффективности

offer_categoryarray of string

Укажите категории предложений, по которым вы хотите получить данные

offer_typearray of string

Укажите типы предложений, по которым вы хотите получить данные

offer_idarray of string

Укажите конкретные предложения, по которым вы хотите получить данные

period_unitstring

Укажите временной интервал для агрегации аналитических данных

One of: "day", "week", "month", "quarter", "year"

segmentationstring

Задаёт основу для сегментации

use_trialboolean

Логическое значение, указывающее, использовался ли пробный период

formatstring

Укажите формат экспортируемого файла

One of: "json", "csv"

Responses

Данные об удержании успешно получены

Schema

Ответ, содержащий данные об удержании пользователей с течением времени

dataarray of object

Массив точек данных об удержании (может быть пустым для некоторых типов удержания)

titlestring

Отображаемое название метрики удержания

metric_namestring

Внутреннее название метрики удержания

descriptionstring

Пояснение способа расчёта удержания (абсолютные или относительные значения)

value_typestring

Тип значения удержания (абсолютное или относительное)

Example 
{
  "data": [],
  "title": "Subscription retention",
  "metric_name": "Subscription retention",
  "description": "Absolute value is the amount of users who entered the current step - subscribed for a trial or paid for a subscription. Relative is calculated as a percentage of these users among those who got a trial. So it starts with 100% for the trial step.",
  "value_type": null
}

Неверный запрос

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Не авторизован

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Превышено ограничение по частоте запросов. Максимум 2 запроса в секунду на один API-ключ.