POST /api/v1/client-api/metrics/cohort/

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

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

Выручка в этом эндпоинте основана на когорте по дате установки: выручка каждого пользователя привязана к его дате установки, а не к дате транзакции. В ответе возвращаются поля total_revenue_usd и total_proceeds_usd. Используйте этот эндпоинт (вместо аналитического) для сверки внутренних отчётов с Ads Manager, который также основан на когортах/датах установки.

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

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

period_unitstring

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

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

period_typestring

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

One of: "renewals", "days"

value_typestring

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

One of: "absolute", "relative"

value_fieldstring

Укажите тип отображаемых значений

One of: "revenue", "arppu", "arpu", "arpas", "subscribers", "subscriptions"

accounting_typestring

Используемый метод учёта

One of: "revenue", "proceeds", "net_revenue"

renewal_daysarray of integer

Список дней с момента установки приложения для типа когорты period_type=days

prediction_monthsinteger

Укажите количество месяцев прогноза

One of: 3, 6, 9, 12, 18, 24

formatstring

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

One of: "json", "csv"

Responses

Данные когорты успешно получены

Schema

Ответ, содержащий данные анализа когорт, показывающие поведение пользователей с течением времени

dataarray of object

Массив сегментов когорт, каждый из которых представляет группу пользователей, начавших в одном периоде

segment_start_datestring

Дата начала данного сегмента когорты

typestring

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

titlestring

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

total_installsinteger

Общее количество установок приложения в данной когорте

total_subscriptionsinteger

Общее количество подписок в данной когорте

total_paid_subscribersinteger

Общее количество платных подписчиков в данной когорте

total_revenue_usdnumber

Общая выручка в USD для данной когорты

total_proceeds_usdnumber

Общие поступления в USD для данной когорты (после вычета комиссий стора)

total_net_revenue_usdnumber

Общая чистая выручка в USD для данной когорты

total_anrpas_usdnumber

Общая средняя выручка на одного активного подписчика (ANRPAS) в USD

total_appas_usdnumber

Общие средние поступления на одного активного подписчика (APPAS) в USD

total_arpas_usdnumber

Общая средняя выручка на одного активного подписчика (ARPAS) в USD

total_anrppu_usdnumber

Общая средняя выручка на одного платящего пользователя (ANRPPU) в USD

total_apppu_usdnumber

Общие средние поступления на одного платящего пользователя (APPPU) в USD

total_arppu_usdnumber

Общая средняя выручка на одного платящего пользователя (ARPPU) в USD

total_anrpu_usdnumber

Общая средняя выручка на одного пользователя (ANRPU) в USD

total_appu_usdnumber

Общие средние поступления на одного пользователя (APPU) в USD

total_arpu_usdnumber

Общая средняя выручка на одного пользователя (ARPU) в USD

predictobject

Данные прогноза для данной когорты (при наличии)

valuesarray of object

Массив значений по периодам, отражающих динамику когорты во времени

arpas_usdnumber

Средняя выручка на одного активного подписчика в USD за данный период

appas_usdnumber

Средние поступления на одного активного подписчика в USD за данный период

anrpas_usdnumber

Средняя чистая выручка на одного активного подписчика в USD за данный период

anrppu_usdnumber

Средняя чистая выручка на одного платящего пользователя в USD за данный период

apppu_usdnumber

Средние поступления на одного платящего пользователя в USD за данный период

arppu_usdnumber

Средняя выручка на одного платящего пользователя в USD за данный период

anrpu_usdnumber

Средняя чистая выручка на одного пользователя в USD за данный период

appu_usdnumber

Средние поступления на одного пользователя в USD за данный период

arpu_usdnumber

Средняя выручка на одного пользователя в USD за данный период

installsinteger

Количество установок приложения за данный период

periodinteger

Номер периода (1 = первый период, 2 = второй период и т. д.)

revenue_usdnumber

Общая выручка в USD за данный период

proceeds_usdnumber

Общие поступления в USD за данный период (после вычета комиссии стора)

net_revenue_usdnumber

Общая чистая выручка в USD за данный период

revenue_relativenumber

Выручка в процентах относительно первого периода (100% = первый период)

proceeds_relativenumber

Поступления в процентах относительно первого периода (100% = первый период)

net_revenue_relativenumber

Чистая выручка в процентах относительно первого периода (100% = первый период)

subscriptionsinteger

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

subscriptions_relativenumber

Подписки в процентах относительно первого периода (100% = первый период)

subscribersinteger

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

subscribers_relativenumber

Подписчики в процентах относительно первого периода (100% = первый период)

currently_active_periodboolean

Является ли данный период текущим активным периодом для когорты

Example

{
  "data": [
    {
      "segment_start_date": "2024-04-01",
      "type": "total",
      "title": "Total",
      "total_installs": 0,
      "total_subscriptions": 0,
      "total_paid_subscribers": 0,
      "total_revenue_usd": 0,
      "total_proceeds_usd": 0,
      "total_net_revenue_usd": 0,
      "total_anrpas_usd": 0,
      "total_appas_usd": 0,
      "total_arpas_usd": 0,
      "total_anrppu_usd": 0,
      "total_apppu_usd": 0,
      "total_arppu_usd": 0,
      "total_anrpu_usd": 0,
      "total_appu_usd": 0,
      "total_arpu_usd": 0,
      "predict": null,
      "values": [
        {
          "arpas_usd": 0,
          "appas_usd": 0,
          "anrpas_usd": 0,
          "anrppu_usd": 0,
          "apppu_usd": 0,
          "arppu_usd": 0,
          "anrpu_usd": 0,
          "appu_usd": 0,
          "arpu_usd": 0,
          "installs": 0,
          "period": 1,
          "revenue_usd": 0,
          "proceeds_usd": 0,
          "net_revenue_usd": 0,
          "revenue_relative": 0,
          "proceeds_relative": 0,
          "net_revenue_relative": 0,
          "subscriptions": 0,
          "subscriptions_relative": 0,
          "subscribers": 0,
          "subscribers_relative": 0,
          "currently_active_period": false
        }
      ]
    }
  ]
}

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

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/cohort/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-04-01",
        "2024-09-30"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ]
    },
    "period_unit": "month",
    "period_type": "renewals",
    "value_type": "absolute",
    "value_field": "subscriptions"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-04-01",
        "2024-09-30"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ]
    },
    "period_unit": "month",
    "period_type": "renewals",
    "value_type": "absolute",
    "value_field": "subscriptions"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-04-01",
          "2024-09-30"
        ],
        "store": [
          "app_store"
        ],
        "country": [
          "us"
        ]
      },
      "period_unit": "month",
      "period_type": "renewals",
      "value_type": "absolute",
      "value_field": "subscriptions"
    })
data = response.json()