POST /api/v1/client-api/metrics/conversion/

Получить данные конверсии

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

Уникальный идентификатор продукта в сторе

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

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

from_periodstring | nullrequired

Начальное состояние подписки пользователя в рамках конверсии

to_periodstringrequired

Новое состояние подписки пользователя после конверсии

period_unitstring

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

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

date_typestring

Укажите, какая дата должна считаться датой присоединения пользователя

One of: "purchase_date", "profile_install_date"

segmentationstring

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

formatstring

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

One of: "json", "csv"

Responses

Данные конверсии успешно получены

Schema

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

dataarray of object

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

valuenumber

Значение коэффициента конверсии

value_frominteger

Начальное состояние подписки для конверсии

value_tointeger

Целевое состояние подписки для конверсии

compare_value_fromnumber

Начальное значение за период сравнения

compare_value_tonumber

Конечное значение за период сравнения

titlestring

Отображаемое название, описывающее тип конверсии

typestring

Тип метрики конверсии

default_aggregationstring

Метод агрегации по умолчанию для данной метрики

descriptionstring

Подробное объяснение того, как вычисляется коэффициент конверсии

metric_namestring

Внутреннее название метрики конверсии

is_jsonboolean

Указывает, представлены ли данные в формате JSON

unitstring

Единица измерения (как правило, 'percent' для коэффициентов конверсии)

recommended_periodobject

Рекомендуемый диапазон дат для данной метрики конверсии

date_fromstring

Дата начала рекомендуемого периода

date_tostring

Дата окончания рекомендуемого периода

period_unitstring

Рекомендуемая единица периода

Example 
{
  "data": [],
  "value": 0,
  "value_from": 0,
  "value_to": 0,
  "compare_value_from": null,
  "compare_value_to": null,
  "title": "Conversion rate from Paid to more than 6 months",
  "type": "multi",
  "default_aggregation": "sum",
  "description": "If Х - the number of the 1st payments taken during the selected date, and Y - the amount of the renewals that happened after the 6 months since the selected date from those 1st payments, then Conversion = (Y / X) * 100%. For example, we had 100 1st subscriptions of various products on the 1st of January and among them 20 renewed on the 1st week of July (the 25th payment). On the 8th of July, we open the chart and see the conversion of the 1st of January = (20 / 100) * 100% = 20%. Then 30 more subscribers of the 1st of January renewed by the start of August (the 8th payment). We open the chart on the 1st of August and see that the conversion of the 1st of January = ((20+30) / 100) * 100% = 50%. This number shows which part of those who had their 1st payment on the 1st of January converted to the period > 6 months with any number of payments by the current moment.",
  "metric_name": "from_paid_to_6_months_conversion",
  "is_json": true,
  "unit": "percent",
  "recommended_period": {
    "date_from": "2018-04-29",
    "date_to": "2024-12-31",
    "period_unit": "month"
  }
}

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

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-ключ.