POST /api/v1/client-api/metrics/cohort/

Récupérer les données de cohorte

Récupérez les données de cohorte pour suivre des groupes d'utilisateurs dans le temps.

Les revenus de cet endpoint sont basés sur la cohorte par date d'installation : les revenus de chaque utilisateur sont attribués à leur date d'installation, et non à la date de transaction. La réponse expose total_revenue_usd et total_proceeds_usd. Utilisez cet endpoint (plutôt que l'endpoint analytics) pour réconcilier les rapports internes avec Ads Manager, qui est également basé sur les cohortes/dates d'installation.

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"

period_typestring

Analyser les données par renouvellements ou par jours

One of: "renewals", "days"

value_typestring

Spécifiez le mode d'affichage des valeurs

One of: "absolute", "relative"

value_fieldstring

Spécifiez le type de valeurs affichées

One of: "revenue", "arppu", "arpu", "arpas", "subscribers", "subscriptions"

accounting_typestring

La méthode comptable utilisée

One of: "revenue", "proceeds", "net_revenue"

renewal_daysarray of integer

Liste des jours écoulés depuis l'installation de l'application pour le type de cohorte period_type=days

prediction_monthsinteger

Indiquez le nombre de mois de prédiction souhaité

One of: 3, 6, 9, 12, 18, 24

formatstring

Spécifiez le format du fichier d'export

One of: "json", "csv"

Responses

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

Schema

Réponse contenant les données d'analyse de cohorte montrant le comportement des utilisateurs au fil du temps

dataarray of object

Tableau de segments de cohorte, chacun représentant un groupe d'utilisateurs ayant démarré durant la même période

segment_start_datestring

La date de début de ce segment de cohorte

typestring

Type de segment ('total' pour les données agrégées, 'single' pour une cohorte individuelle)

titlestring

Titre d'affichage pour ce segment de cohorte

total_installsinteger

Nombre total d'installations de l'application dans cette cohorte

total_subscriptionsinteger

Nombre total d'abonnements dans cette cohorte

total_paid_subscribersinteger

Nombre total d'abonnés payants dans cette cohorte

total_revenue_usdnumber

Revenu total en USD pour cette cohorte

total_proceeds_usdnumber

Recettes totales en USD pour cette cohorte (après déduction des frais du store)

total_net_revenue_usdnumber

Revenu net total en USD pour cette cohorte

total_anrpas_usdnumber

Revenu moyen total par abonné actif (ANRPAS) en USD

total_appas_usdnumber

Recettes moyennes totales par abonné actif (APPAS) en USD

total_arpas_usdnumber

Revenu moyen total par abonné actif (ARPAS) en USD

total_anrppu_usdnumber

Revenu moyen total par utilisateur payant (ANRPPU) en USD

total_apppu_usdnumber

Recettes moyennes totales par utilisateur payant (APPPU) en USD

total_arppu_usdnumber

Revenu moyen total par utilisateur payant (ARPPU) en USD

total_anrpu_usdnumber

Revenu moyen total par utilisateur (ANRPU) en USD

total_appu_usdnumber

Recettes moyennes totales par utilisateur (APPU) en USD

total_arpu_usdnumber

Revenu moyen total par utilisateur (ARPU) en USD

predictobject

Données de prédiction pour cette cohorte (si disponibles)

valuesarray of object

Tableau de valeurs par période illustrant les performances de la cohorte dans le temps

arpas_usdnumber

Revenu moyen par abonné actif en USD pour cette période

appas_usdnumber

Produit moyen par abonné actif en USD pour cette période

anrpas_usdnumber

Revenu net moyen par abonné actif en USD pour cette période

anrppu_usdnumber

Revenu net moyen par utilisateur payant en USD pour cette période

apppu_usdnumber

Produit moyen par utilisateur payant en USD pour cette période

arppu_usdnumber

Revenu moyen par utilisateur payant en USD pour cette période

anrpu_usdnumber

Revenu net moyen par utilisateur en USD pour cette période

appu_usdnumber

Produit moyen par utilisateur en USD pour cette période

arpu_usdnumber

Revenu moyen par utilisateur en USD pour cette période

installsinteger

Nombre d'installations de l'application au cours de cette période

periodinteger

Numéro de période (1 = première période, 2 = deuxième période, etc.)

revenue_usdnumber

Revenu total en USD pour cette période

proceeds_usdnumber

Produit total en USD pour cette période (après déduction des frais du store)

net_revenue_usdnumber

Revenu net total en USD pour cette période

revenue_relativenumber

Revenu en pourcentage par rapport à la première période (100% = première période)

proceeds_relativenumber

Produit en pourcentage par rapport à la première période (100% = première période)

net_revenue_relativenumber

Revenu net en pourcentage par rapport à la première période (100% = première période)

subscriptionsinteger

Nombre d'abonnements au cours de cette période

subscriptions_relativenumber

Abonnements en pourcentage par rapport à la première période (100% = première période)

subscribersinteger

Nombre d'abonnés au cours de cette période

subscribers_relativenumber

Abonnés en pourcentage par rapport à la première période (100% = première période)

currently_active_periodboolean

Indique si cette période est la période actuellement active pour la cohorte

Example

{
  "data": [
    {
      "segment_start_date": "2024-04-01",
      "type": "total",
      "title": "Total",
      "total_installs": 0,
      "total_subscriptions": 0,
      "total_paid_subscribers": 0,
      "total_revenue_usd": 0,
      "total_proceeds_usd": 0,
      "total_net_revenue_usd": 0,
      "total_anrpas_usd": 0,
      "total_appas_usd": 0,
      "total_arpas_usd": 0,
      "total_anrppu_usd": 0,
      "total_apppu_usd": 0,
      "total_arppu_usd": 0,
      "total_anrpu_usd": 0,
      "total_appu_usd": 0,
      "total_arpu_usd": 0,
      "predict": null,
      "values": [
        {
          "arpas_usd": 0,
          "appas_usd": 0,
          "anrpas_usd": 0,
          "anrppu_usd": 0,
          "apppu_usd": 0,
          "arppu_usd": 0,
          "anrpu_usd": 0,
          "appu_usd": 0,
          "arpu_usd": 0,
          "installs": 0,
          "period": 1,
          "revenue_usd": 0,
          "proceeds_usd": 0,
          "net_revenue_usd": 0,
          "revenue_relative": 0,
          "proceeds_relative": 0,
          "net_revenue_relative": 0,
          "subscriptions": 0,
          "subscriptions_relative": 0,
          "subscribers": 0,
          "subscribers_relative": 0,
          "currently_active_period": false
        }
      ]
    }
  ]
}

Requête invalide

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/cohort/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-04-01",
        "2024-09-30"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ]
    },
    "period_unit": "month",
    "period_type": "renewals",
    "value_type": "absolute",
    "value_field": "subscriptions"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-04-01",
        "2024-09-30"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ]
    },
    "period_unit": "month",
    "period_type": "renewals",
    "value_type": "absolute",
    "value_field": "subscriptions"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-04-01",
          "2024-09-30"
        ],
        "store": [
          "app_store"
        ],
        "country": [
          "us"
        ]
      },
      "period_unit": "month",
      "period_type": "renewals",
      "value_type": "absolute",
      "value_field": "subscriptions"
    })
data = response.json()