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

Récupérer les données d'entonnoir

Copy as Markdown

Récupère les données d'entonnoir pour suivre la progression des utilisateurs à travers les étapes spécifiques d'un processus de conversion.

Limite de taux : 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 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

placement_idarray of string

Identifiants internes Adapty des placements pour lesquels récupérer des données — l'UUID figurant dans l'URL du placement dans le dashboard, et non l'identifiant de placement que vous transmettez au SDK

audience_idarray of string

Identifiants internes Adapty des audiences de placement pour lesquelles récupérer des données

paywall_idarray of string

Identifiants internes Adapty des paywalls pour lesquels récupérer des données — l'UUID figurant dans l'URL du paywall dans le dashboard

flow_idarray of string

Identifiants internes Adapty des flows pour lesquels récupérer des données — l'UUID figurant dans l'URL du flow dans le dashboard

flow_screen_idarray of string

Écrans de flow pour lesquels récupérer des données, chacun au format <flow_id>:<screen_id> — par exemple 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall

segment_idarray of string

Identifiants internes Adapty des segments pour lesquels récupérer des données

show_value_asstring

Spécifier comment les valeurs sont affichées

One of: "absolute", "relative", "both"

segmentationstring

Divise les données en une série par valeur de cette dimension. Par exemple, flow_id retourne une série distincte pour chaque flow, et placement_id pour chaque 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"

formatstring

Spécifier le format du fichier d'export

One of: "json", "csv"

Responses

Données d'entonnoir récupérées avec succès

Schema

Réponse contenant les données d'analyse de l'entonnoir montrant la progression des utilisateurs à travers les étapes de conversion

dataarray of object

Tableau de segments d'entonnoir montrant les différentes étapes du processus de conversion

titlestring

Titre d'affichage pour ce segment d'entonnoir

typestring

Type de segment d'entonnoir ('total' pour les données agrégées)

valuesarray of object

Tableau de valeurs d'entonnoir montrant la progression à travers les étapes

periodinteger

Numéro de période dans l'entonnoir (-2 = Installation, -1 = Paywall affiché, etc.)

titlestring

Titre d'affichage de cette étape de l'entonnoir

valueinteger

Nombre d'utilisateurs ayant atteint cette étape

value_relativenumber

Pourcentage d'utilisateurs ayant atteint cette étape par rapport à la première étape

relative_changesnumber

Variation du taux de conversion par rapport à la période précédente

following_changesobject

Informations sur les utilisateurs ayant abandonné après cette étape

titlestring

Titre de l'étape d'abandon

valueinteger

Nombre d'utilisateurs ayant abandonné

value_relativenumber

Pourcentage d'utilisateurs ayant abandonné

churn_reason_titlestring

Titre décrivant la raison du churn à cette étape

churn_reasonsarray of object

Tableau des raisons spécifiques de churn

valuesarray of object

Valeurs imbriquées supplémentaires pour cette étape de l'entonnoir

Example 
{
  "data": [
    {
      "title": "Total",
      "type": "total",
      "values": [
        {
          "period": -2,
          "title": "Install",
          "value": 2,
          "value_relative": 100,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 2,
            "value_relative": 100
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        },
        {
          "period": -1,
          "title": "Paywall displayed",
          "value": 0,
          "value_relative": 0,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 0,
            "value_relative": 0
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        }
      ]
    }
  ]
}

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 taux dépassée. Maximum 2 requêtes par seconde par application, partagée par toutes les clés API de l'application.