POST /api/v1/client-api/exports/placements/

Получить информацию о плейсменте

Возвращает настройки ваших плейсментов пейвола, онбординга или флоу: аудитории, сегменты и A/B-тесты в каждом плейсменте, а также пейвол, онбординг или флоу, которые получает каждая аудитория. Это позволяет убедиться в правильности настройки, не открывая каждый плейсмент по отдельности.

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

Request body

filtersobjectrequired

placement_typestringrequired

Тип плейсментов для возврата. Каждый запрос возвращает плейсменты одного типа.

One of: "paywall", "onboarding", "flow"

Responses

Информация о плейсменте успешно получена

Schema

Ответ содержит один массив, названный в соответствии с запрошенным placement_type: paywall_placements, onboarding_placements или flow_placements.

paywall_placementsarray of object

Возвращается, когда placement_type равен paywall

developer_idstring

ID плейсмента

placement_namestring

Название плейсмента

audience_namestring

Название аудитории

segment_namestring

Название сегмента, на котором основана аудитория

cross_placement_ab_test_namestring

Название кросс-плейсментного A/B-теста

ab_test_namestring

Название A/B-теста

paywall_namestring

Название пейвола, отображаемого в данном плейсменте

onboarding_placementsarray of object

Возвращается, когда placement_type равен onboarding

developer_idstring

Идентификатор плейсмента

placement_namestring

Название плейсмента

audience_namestring

Название аудитории

segment_namestring

Название сегмента, на котором основана аудитория

cross_placement_ab_test_namestring

Название межплейсментного A/B-теста

ab_test_namestring

Название A/B-теста

onboarding_namestring

Название онбординга, отображаемого в этом плейсменте

flow_placementsarray of object

Возвращается, когда placement_type равен flow

developer_idstring

Идентификатор плейсмента

placement_namestring

Название плейсмента

audience_namestring

Название аудитории

segment_namestring

Название сегмента, на котором основана аудитория

cross_placement_ab_test_namestring

Название кросс-плейсментного A/B-теста

ab_test_namestring

Название A/B-теста

flow_namestring

Название флоу, отображаемого в данном плейсменте

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

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/exports/placements/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "placement_type": "paywall"
    }
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/exports/placements/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "placement_type": "paywall"
    }
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/exports/placements/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "placement_type": "paywall"
      }
    })
data = response.json()