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

Recuperar información de placement

Recupera la configuración de tus placements de paywall, onboarding o flow: las audiencias, segmentos y pruebas A/B en cada placement, y el paywall, onboarding o flow que recibe cada audiencia. Esto puede ayudarte a asegurarte de que todo está configurado correctamente sin tener que abrir cada placement por separado.

Límite de velocidad: 2 solicitudes por segundo.

Request body

filtersobjectrequired

placement_typestringrequired

Tipo de placements a devolver. Cada solicitud devuelve placements de un único tipo.

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

Responses

Información de placement recuperada correctamente

Schema

La respuesta contiene un array, nombrado según el placement_type solicitado: paywall_placements, onboarding_placements o flow_placements.

paywall_placementsarray of object

Se devuelve cuando placement_type es paywall

developer_idstring

ID del placement

placement_namestring

Nombre del placement

audience_namestring

Nombre de la audiencia

segment_namestring

Nombre del segmento en el que se basa la audiencia

cross_placement_ab_test_namestring

Nombre de la prueba A/B entre placements

ab_test_namestring

Nombre de la prueba A/B

paywall_namestring

Nombre del paywall mostrado en este placement

onboarding_placementsarray of object

Se devuelve cuando placement_type es onboarding

developer_idstring

ID del placement

placement_namestring

Nombre del placement

audience_namestring

Nombre de la audiencia

segment_namestring

Nombre del segmento en el que se basa la audiencia

cross_placement_ab_test_namestring

Nombre de la prueba A/B entre placements

ab_test_namestring

Nombre de la prueba A/B

onboarding_namestring

Nombre del onboarding mostrado en este placement

flow_placementsarray of object

Se devuelve cuando placement_type es flow

developer_idstring

ID del placement

placement_namestring

Nombre del placement

audience_namestring

Nombre de la audiencia

segment_namestring

Nombre del segmento en el que se basa la audiencia

cross_placement_ab_test_namestring

Nombre de la prueba A/B entre placements

ab_test_namestring

Nombre de la prueba A/B

flow_namestring

Nombre del flow mostrado en este placement

Solicitud incorrecta

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

No autorizado

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Límite de velocidad superado. Máximo 2 solicitudes por segundo por clave de 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()