English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v1/client-api/metrics/retention/

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

Copy as Markdown

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

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

Request body

filtersobjectrequired
datearray of stringrequired

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

compare_datearray of string

Entrez la date ou la période de comparaison

storearray of string

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

countryarray of string

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

store_product_idarray of string

Identifiant unique d'un produit dans le store

durationarray of string

Indiquez 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 leur efficacité

offer_categoryarray of string

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

offer_typearray of string

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

offer_idarray of string

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

period_unitstring

Indiquez l'intervalle de temps pour l'agrégation des données d'analyse

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

segmentationstring

Définit la base de la segmentation

use_trialboolean

Valeur booléenne indiquant si un essai a été utilisé

formatstring

Indiquez le format de 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 dans le 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.