POST /api/v1/client-api/metrics/retention/

Получить данные по удержанию

Copy as Markdown

Возвращает данные по удержанию для анализа способности продукта удерживать пользователей на протяжении времени.

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

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"

use_trialboolean

Булево значение, указывающее, использовался ли пробный период

formatstring

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

One of: "json", "csv"

Responses

Данные по удержанию успешно получены

Schema

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

dataarray of object

Массив точек данных об удержании (может быть пустым для некоторых типов удержания)

titlestring

Отображаемое название метрики удержания

metric_namestring

Внутреннее название метрики удержания

descriptionstring

Пояснение способа расчёта удержания (абсолютные или относительные значения)

value_typestring

Тип значения удержания (абсолютное или относительное)

Example

{
  "data": [],
  "title": "Subscription retention",
  "metric_name": "Subscription retention",
  "description": "Absolute value is the amount of users who entered the current step - subscribed for a trial or paid for a subscription. Relative is calculated as a percentage of these users among those who got a trial. So it starts with 100% for the trial step.",
  "value_type": 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-ключами приложения.

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/retention/' \
  --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"
      ]
    },
    "segmentation": "store_product_id",
    "format": "csv"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/retention/', {
  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"
      ]
    },
    "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/retention/', 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"
        ]
      },
      "segmentation": "store_product_id",
      "format": "csv"
    })
data = response.json()