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

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

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

Ограничение по частоте запросов: 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 для получения данных

from_periodstring | nullrequired

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

to_periodstringrequired

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

period_unitstring

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

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

date_typestring

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

One of: "purchase_date", "profile_install_date"

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

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

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

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ]
      },
      "from_period": 1,
      "to_period": "6+",
      "period_unit": "month",
      "date_type": "purchase_date",
      "segmentation": "country",
      "format": "json"
    })
data = response.json()