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

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

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

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

Request body

filtersobjectrequired

placement_typestringrequired

Фильтр для выбора типа плейсментов, которые будут возвращены в ответе

One of: "paywall", "onboarding"

Responses

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

Schema

dataarray of object

developer_idstring

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

placement_namestring

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

audience_namestring

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

segment_namestring

Идентификатор аудитории

cross_placement_ab_test_namestring

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

ab_test_namestring

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

paywall_namestring

Название пейвола (возвращается только если placement_type равен paywall)

onboarding_namestring

Название онбординга (возвращается только если placement_type равен onboarding)

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

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()