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

Retrieve placement info

Retrieves information about paywall or onboarding placements: paywalls, segments, audiences, and A/B tests. This can help you ensure everything is set up correctly without having to open each placement you have separately.

Rate limit: 2 requests per second.

Request body

filtersobjectrequired

placement_typestringrequired

Filter which placements will be sent in the response

One of: "paywall", "onboarding"

Responses

Placement information retrieved successfully

Schema

dataarray of object

developer_idstring

Placement ID

placement_namestring

Placement name

audience_namestring

Audience name

segment_namestring

Audience ID

cross_placement_ab_test_namestring

Cross-placement A/B test name

ab_test_namestring

A/B test name

paywall_namestring

Paywall name (only returned if placement_type is paywall)

onboarding_namestring

Onboarding name (only returned if placement_type is onboarding)

Bad Request

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Unauthorized

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Rate limit exceeded. Maximum 2 requests per second per API key.

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