POST /api/v1/client-api/metrics/retention/

Recuperar datos de retención

Recupera los datos de retención para analizar la capacidad de un producto para mantener a los usuarios comprometidos a lo largo del tiempo.

Límite de solicitudes: 2 solicitudes por segundo.

Request body

filtersobjectrequired

datearray of stringrequired

Introduce la fecha o el período de tiempo para el que deseas recuperar los datos del gráfico

compare_datearray of string

Introduce la fecha o el período de tiempo de comparación

storearray of string

Filtra por el store donde se realizó la compra

countryarray of string

Filtra por el código de país de 2 letras donde se realizó la compra

store_product_idarray of string

ID de producto cualificado por store, con el formato <store>:<product_id> — por ejemplo app_store:premium_monthly o play_store:premium_sub:monthly-base-plan para una suscripción de Google con un plan base. Se rechaza un ID de producto sin prefijo de store.

durationarray of string

Especifica la duración de la suscripción

attribution_sourcearray of string

La integración de origen para la atribución

attribution_statusarray of string

Indica si la atribución es orgánica o no orgánica

attribution_channelarray of string

Canal de marketing que originó la transacción

attribution_campaignarray of string

Campaña de marketing que originó la transacción

attribution_adgrouparray of string

Grupo de anuncios de atribución que originó la transacción

attribution_adsetarray of string

Conjunto de anuncios de atribución que originó la transacción

attribution_creativearray of string

Elementos visuales o de texto específicos de un anuncio o campaña que se rastrean para medir su efectividad

offer_categoryarray of string

Especifica las categorías de oferta para las que deseas recuperar datos

offer_typearray of string

Especifica los tipos de oferta para los que deseas recuperar datos

offer_idarray of string

Especifica las ofertas concretas para las que deseas recuperar datos

placement_idarray of string

IDs internos de Adapty de los placements para los que se recuperarán datos — el UUID que aparece en la URL del placement en el dashboard, no el ID de placement que se pasa al SDK

audience_idarray of string

IDs internos de Adapty de las audiencias de placement para las que se recuperarán datos

paywall_idarray of string

IDs internos de Adapty de los paywalls para los que se recuperarán datos — el UUID que aparece en la URL del paywall en el dashboard

flow_idarray of string

IDs internos de Adapty de los flows para los que se recuperarán datos — el UUID que aparece en la URL del flow en el dashboard

flow_screen_idarray of string

Pantallas de flow para las que se recuperarán datos, cada una con el formato <flow_id>:<screen_id> — por ejemplo 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall

segment_idarray of string

IDs internos de Adapty de los segmentos para los que se recuperarán datos

segmentationstring

Divide los datos en una serie por cada valor de esta dimensión. Por ejemplo, flow_id devuelve una serie separada para cada flow, y placement_id para cada placement.

One of: "period", "renewal_status", "cancellation_reason", "store_product_id", "country", "store", "paywall_id", "audience_id", "placement_id", "flow_id", "flow_screen_id", "segment_id", "duration", "offer_category", "offer_type", "offer_id", "attribution_source", "attribution_status", "attribution_channel", "attribution_campaign", "attribution_adgroup", "attribution_adset", "attribution_creative", "day", "week", "month", "year"

use_trialboolean

Valor booleano que indica si se utilizó un período de prueba

formatstring

Especifica el formato del archivo de exportación

One of: "json", "csv"

Responses

Datos de retención recuperados correctamente

Schema

Respuesta que contiene datos de retención que muestran la participación de los usuarios a lo largo del tiempo

dataarray of object

Array de puntos de datos de retención (puede estar vacío para algunos tipos de retención)

titlestring

Título de visualización para la métrica de retención

metric_namestring

Nombre interno de la métrica de retención

descriptionstring

Explicación de cómo se calcula la retención (valores absolutos o relativos)

value_typestring

Tipo de valor de retención (absoluto o relativo)

Example

{
  "data": [],
  "title": "Subscription retention",
  "metric_name": "Subscription retention",
  "description": "Absolute value is the amount of users who entered the current step - subscribed for a trial or paid for a subscription. Relative is calculated as a percentage of these users among those who got a trial. So it starts with 100% for the trial step.",
  "value_type": null
}

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 solicitudes superado. Máximo 2 solicitudes por segundo por aplicación, compartido por todas las claves API de la aplicación.

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/retention/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ],
      "compare_date": [
        "2023-01-01",
        "2023-12-31"
      ]
    },
    "segmentation": "store_product_id",
    "format": "csv"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/retention/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ],
      "compare_date": [
        "2023-01-01",
        "2023-12-31"
      ]
    },
    "segmentation": "store_product_id",
    "format": "csv"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/retention/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ],
        "compare_date": [
          "2023-01-01",
          "2023-12-31"
        ]
      },
      "segmentation": "store_product_id",
      "format": "csv"
    })
data = response.json()