English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v1/client-api/metrics/analytics/

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

Copy as Markdown

Возвращает аналитические данные для анализа поведения пользователей и метрик производительности, которые в дальнейшем используются в графиках.

Выручка из этого эндпоинта рассчитывается на основе событий: каждое значение привязывается к дате транзакции — дню, когда произошла покупка, продление или возврат. Чтобы привязать выручку к дате установки каждого пользователя (например, для сверки с Ads Manager), используйте эндпоинт когорт (POST /api/v1/client-api/metrics/cohort/).

Ограничение по частоте запросов: 2 запроса в секунду.

Request body

chart_idstringrequired

Укажите нужный график. В каждом запросе можно указать только один тип графика.

One of: "revenue", "mrr", "arr", "arppu", "subscriptions_active", "subscriptions_new", "subscriptions_renewal_cancelled", "subscriptions_expired", "trials_active", "trials_new", "trials_renewal_cancelled", "trials_expired", "grace_period", "billing_issue", "refund_events", "refund_money", "non_subscriptions", "arpu", "installs"

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"

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

Ответ, содержащий аналитические данные для запрошенного типа графика

dataobject

Объект, содержащий различные типы метрик (revenue, proceeds, net_revenue и т. д.)

Example 
{
  "data": {
    "revenue": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": null
    },
    "proceeds": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": null
    },
    "net_revenue": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": null
    }
  }
}

Некорректный запрос

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