POST /api/v1/client-api/metrics/ltv/

Получить данные пожизненной ценности (LTV)

Copy as Markdown

Возвращает данные LTV для оценки долгосрочного потенциала дохода от клиентов в течение периода их взаимодействия с продуктом.

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

period_typestring

Анализировать данные по продлениям или по дням

One of: "renewals", "days"

segmentationstring

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

formatstring

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

One of: "json", "csv"

Responses

Данные LTV успешно получены

Schema

Ответ, содержащий данные пожизненной ценности (LTV) для различных типов дохода

revenueobject

LTV, рассчитанный на основе валового дохода

dataarray of object

Массив точек данных LTV для различных когорт

titlestring

Отображаемое название данной точки данных LTV

typestring

Тип данных LTV ('total' для агрегированных данных)

valuenumber

Значение LTV для данной когорты

valuesarray of object

Массив периодических значений LTV

cohort_sizeinteger

Количество пользователей в данной когорте

descriptionstring

HTML-описание, объясняющее методику расчёта LTV

valuenumber

Общее значение LTV

unitstring

Единица измерения (как правило, 'USD')

titlestring

Отображаемое название данной метрики LTV

proceedsobject

LTV, рассчитанный на основе поступлений (после вычета комиссии стора)

dataarray of object

Массив точек данных LTV для различных когорт

titlestring

Отображаемое название данной точки данных LTV

typestring

Тип данных LTV ('total' для агрегированных данных)

valuenumber

Значение LTV для данной когорты

valuesarray of object

Массив периодических значений LTV

cohort_sizeinteger

Количество пользователей в данной когорте

descriptionstring

HTML-описание, объясняющее методику расчёта LTV

valuenumber

Общее значение LTV

unitstring

Единица измерения (как правило, 'USD')

titlestring

Отображаемое название данной метрики LTV

net_revenueobject

LTV, рассчитанный на основе чистого дохода

dataarray of object

Массив точек данных LTV для различных когорт

titlestring

Отображаемое название данной точки данных LTV

typestring

Тип данных LTV ('total' для агрегированных данных)

valuenumber

Значение LTV для данной когорты

valuesarray of object

Массив периодических значений LTV

cohort_sizeinteger

Количество пользователей в данной когорте

descriptionstring

HTML-описание, объясняющее методику расчёта LTV

valuenumber

Общее значение LTV

unitstring

Единица измерения (как правило, 'USD')

titlestring

Отображаемое название данной метрики LTV

Example 
{
  "revenue": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  },
  "proceeds": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  },
  "net_revenue": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  }
}

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

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