English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
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

Идентификатор продукта с указанием стора в формате <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

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

placement_idarray of string

Внутренние идентификаторы плейсментов Adapty для получения данных — UUID из URL плейсмента в дашборде, а не идентификатор плейсмента, передаваемый в SDK

audience_idarray of string

Внутренние идентификаторы аудиторий плейсментов Adapty для получения данных

paywall_idarray of string

Внутренние идентификаторы пейволов Adapty для получения данных — UUID из URL пейвола в дашборде

flow_idarray of string

Внутренние идентификаторы флоу Adapty для получения данных — UUID из URL флоу в дашборде

flow_screen_idarray of string

Экраны флоу для получения данных, каждый в формате <flow_id>:<screen_id> — например 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall

segment_idarray of string

Внутренние идентификаторы сегментов Adapty для получения данных

show_value_asstring

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

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

segmentationstring

Разбивает данные на отдельные серии по каждому значению этого измерения. Например, flow_id возвращает отдельную серию для каждого флоу, а placement_id — для каждого плейсмента.

One of: "period", "renewal_status", "cancellation_reason", "store_product_id", "country", "store", "paywall_id", "audience_id", "placement_id", "flow_id", "flow_screen_id", "segment_id", "duration", "offer_category", "offer_type", "offer_id", "attribution_source", "attribution_status", "attribution_channel", "attribution_campaign", "attribution_adgroup", "attribution_adset", "attribution_creative", "day", "week", "month", "year"

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-ключей приложения.