POST /api/v1/client-api/metrics/analytics/

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

Copy as Markdown

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

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

Уникальный идентификатор продукта в сторе

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"

date_typestring

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

One of: "purchase_date", "profile_install_date"

segmentationstring

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

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