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

Récupérer les données de rétention

Récupère les données de rétention pour analyser la capacité d'un produit à maintenir l'engagement des utilisateurs au fil du temps.

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

Request body

filtersobjectrequired

datearray of stringrequired

Saisissez la date ou la période pour laquelle vous souhaitez récupérer les données du graphique

compare_datearray of string

Saisissez la date ou la période de comparaison

storearray of string

Filtrer par le store où l'achat a été effectué

countryarray of string

Filtrer par le code pays à 2 lettres où l'achat a eu lieu

store_product_idarray of string

Identifiant de produit qualifié par le store, au format <store>:<product_id> — par exemple app_store:premium_monthly ou play_store:premium_sub:monthly-base-plan pour un abonnement Google avec un plan de base. Un identifiant de produit nu sans préfixe de store est rejeté.

durationarray of string

Spécifiez la durée de l'abonnement

attribution_sourcearray of string

L'intégration source pour l'attribution

attribution_statusarray of string

Indique si l'attribution est organique ou non organique

attribution_channelarray of string

Canal marketing ayant conduit à la transaction

attribution_campaignarray of string

Campagne marketing ayant apporté la transaction

attribution_adgrouparray of string

Groupe d'annonces d'attribution ayant apporté la transaction

attribution_adsetarray of string

Ensemble d'annonces d'attribution ayant conduit à la transaction

attribution_creativearray of string

Éléments visuels ou textuels spécifiques d'une annonce ou d'une campagne suivis pour mesurer l'efficacité

offer_categoryarray of string

Spécifiez les catégories d'offres pour lesquelles vous souhaitez récupérer des données

offer_typearray of string

Spécifiez les types d'offres pour lesquels vous souhaitez récupérer des données

offer_idarray of string

Spécifiez les offres spécifiques pour lesquelles vous souhaitez récupérer des données

period_unitstring

Spécifiez l'intervalle de temps pour l'agrégation des données analytiques

One of: "day", "week", "month", "quarter", "year"

segmentationstring

Définit la base de la segmentation

use_trialboolean

Booléen indiquant si un essai a été utilisé

formatstring

Spécifiez le format du fichier d'export

One of: "json", "csv"

Responses

Données de rétention récupérées avec succès

Schema

Réponse contenant les données de rétention montrant l'engagement des utilisateurs au fil du temps

dataarray of object

Tableau de points de données de rétention (peut être vide pour certains types de rétention)

titlestring

Titre d'affichage pour la métrique de rétention

metric_namestring

Nom interne de la métrique de rétention

descriptionstring

Explication du mode de calcul de la rétention (valeurs absolues ou relatives)

value_typestring

Type de valeur de rétention (absolue ou relative)

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
}

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/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"
      ]
    },
    "period_unit": "quarter",
    "period_type": "renewals",
    "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"
      ]
    },
    "period_unit": "quarter",
    "period_type": "renewals",
    "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"
        ]
      },
      "period_unit": "quarter",
      "period_type": "renewals",
      "segmentation": "store_product_id",
      "format": "csv"
    })
data = response.json()