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

Retrieve placement info

Retrieves the setup of your paywall, onboarding, or flow placements: the audiences, segments, and A/B tests in each placement, and the paywall, onboarding, or flow each audience gets. 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

Type of placements to return. Each request returns placements of one type.

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

Responses

Placement information retrieved successfully

Schema

The response holds one array, named after the placement_type you requested: paywall_placements, onboarding_placements, or flow_placements.

paywall_placementsarray of object

Returned when placement_type is paywall

developer_idstring

Placement ID

placement_namestring

Placement name

audience_namestring

Audience name

segment_namestring

Name of the segment the audience is based on

cross_placement_ab_test_namestring

Cross-placement A/B test name

ab_test_namestring

A/B test name

paywall_namestring

Name of the paywall shown in this placement

onboarding_placementsarray of object

Returned when placement_type is onboarding

developer_idstring

Placement ID

placement_namestring

Placement name

audience_namestring

Audience name

segment_namestring

Name of the segment the audience is based on

cross_placement_ab_test_namestring

Cross-placement A/B test name

ab_test_namestring

A/B test name

onboarding_namestring

Name of the onboarding shown in this placement

flow_placementsarray of object

Returned when placement_type is flow

developer_idstring

Placement ID

placement_namestring

Placement name

audience_namestring

Audience name

segment_namestring

Name of the segment the audience is based on

cross_placement_ab_test_namestring

Cross-placement A/B test name

ab_test_namestring

A/B test name

flow_namestring

Name of the flow shown in this placement

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