POST /api/v1/client-api/metrics/funnel/

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

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

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

period_unitstring

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

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

show_value_asstring

Укажите способ отображения значений

One of: "absolute", "relative", "both"

segmentationstring

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

formatstring

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

One of: "json", "csv"

Responses

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

Schema

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

dataarray of object

Массив сегментов воронки, отражающих различные этапы процесса конверсии

titlestring

Отображаемое название данного сегмента воронки

typestring

Тип сегмента воронки ('total' для агрегированных данных)

valuesarray of object

Массив значений воронки, отражающих прохождение пользователей через этапы

periodinteger

Номер периода в воронке (-2 = установка, -1 = отображение пейвола и т.д.)

titlestring

Отображаемое название данного этапа воронки

valueinteger

Количество пользователей, достигших данного этапа

value_relativenumber

Доля пользователей, достигших данного этапа, относительно первого этапа (в процентах)

relative_changesnumber

Изменение коэффициента конверсии по сравнению с предыдущим периодом

following_changesobject

Информация о пользователях, покинувших воронку после данного этапа

titlestring

Название этапа оттока

valueinteger

Количество пользователей, покинувших воронку

value_relativenumber

Доля пользователей, покинувших воронку (в процентах)

churn_reason_titlestring

Название, описывающее причину оттока на данном этапе

churn_reasonsarray of object

Массив конкретных причин оттока

valuesarray of object

Дополнительные вложенные значения для данного этапа воронки

Example 
{
  "data": [
    {
      "title": "Total",
      "type": "total",
      "values": [
        {
          "period": -2,
          "title": "Install",
          "value": 2,
          "value_relative": 100,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 2,
            "value_relative": 100
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        },
        {
          "period": -1,
          "title": "Paywall displayed",
          "value": 0,
          "value_relative": 0,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 0,
            "value_relative": 0
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        }
      ]
    }
  ]
}

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

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