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

Récupérer les informations de placement

Récupère la configuration de vos placements de paywall, d'onboarding ou de flow : les audiences, les segments et les tests A/B dans chaque placement, ainsi que le paywall, l'onboarding ou le flow que chaque audience reçoit. Cela peut vous aider à vérifier que tout est correctement configuré sans avoir à ouvrir chaque placement séparément.

Limite de débit : 2 requêtes par seconde.

Request body

filtersobjectrequired

placement_typestringrequired

Type de placements à retourner. Chaque requête retourne des placements d'un seul type.

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

Responses

Informations de placement récupérées avec succès

Schema

La réponse contient un seul tableau, nommé selon le placement_type demandé : paywall_placements, onboarding_placements ou flow_placements.

paywall_placementsarray of object

Retourné lorsque placement_type est paywall

developer_idstring

ID du placement

placement_namestring

Nom du placement

audience_namestring

Nom de l'audience

segment_namestring

Nom du segment sur lequel l'audience est basée

cross_placement_ab_test_namestring

Nom du test A/B inter-placement

ab_test_namestring

Nom du test A/B

paywall_namestring

Nom du paywall affiché dans ce placement

onboarding_placementsarray of object

Retourné lorsque placement_type est onboarding

developer_idstring

Identifiant du placement

placement_namestring

Nom du placement

audience_namestring

Nom de l'audience

segment_namestring

Nom du segment sur lequel l'audience est basée

cross_placement_ab_test_namestring

Nom du test A/B cross-placement

ab_test_namestring

Nom du test A/B

onboarding_namestring

Nom de l'onboarding affiché dans ce placement

flow_placementsarray of object

Retourné lorsque placement_type est flow

developer_idstring

ID du placement

placement_namestring

Nom du placement

audience_namestring

Nom de l'audience

segment_namestring

Nom du segment sur lequel l'audience est basée

cross_placement_ab_test_namestring

Nom du test A/B inter-placement

ab_test_namestring

Nom du test A/B

flow_namestring

Nom du flow affiché dans ce placement

Requête incorrecte

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Non autorisé

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Limite de débit dépassée. Maximum 2 requêtes par seconde par clé 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()