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

Получить данные Lifetime Value (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

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

period_unitstring

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

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

period_typestring

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

One of: "renewals", "days"

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

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

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ],
      "compare_date": [
        "2023-01-01",
        "2023-12-31"
      ],
      "offer_category": [
        "introductory"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ],
      "attribution_source": [
        "appsflyer"
      ],
      "attribution_status": [
        "organic"
      ],
      "attribution_channel": [
        "social_media"
      ]
    },
    "period_unit": "quarter",
    "period_type": "renewals",
    "segmentation": "store_product_id",
    "format": "csv"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/', {
  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"
      ],
      "compare_date": [
        "2023-01-01",
        "2023-12-31"
      ],
      "offer_category": [
        "introductory"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ],
      "attribution_source": [
        "appsflyer"
      ],
      "attribution_status": [
        "organic"
      ],
      "attribution_channel": [
        "social_media"
      ]
    },
    "period_unit": "quarter",
    "period_type": "renewals",
    "segmentation": "store_product_id",
    "format": "csv"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ],
        "compare_date": [
          "2023-01-01",
          "2023-12-31"
        ],
        "offer_category": [
          "introductory"
        ],
        "store": [
          "app_store"
        ],
        "country": [
          "us"
        ],
        "attribution_source": [
          "appsflyer"
        ],
        "attribution_status": [
          "organic"
        ],
        "attribution_channel": [
          "social_media"
        ]
      },
      "period_unit": "quarter",
      "period_type": "renewals",
      "segmentation": "store_product_id",
      "format": "csv"
    })
data = response.json()