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

Récupérer les données analytiques

Copy as Markdown

Récupère les données analytiques pour obtenir des informations sur le comportement des utilisateurs et les métriques de performance à utiliser dans les graphiques.

Les revenus de cet endpoint sont basés sur les événements : chaque valeur est attribuée à la date de transaction — le jour où l'achat, le renouvellement ou le remboursement a eu lieu. Pour attribuer les revenus à la date d'installation de chaque utilisateur (par exemple, pour rapprocher les données avec Ads Manager), utilisez l'endpoint cohorte (POST /api/v1/client-api/metrics/cohort/).

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

Request body

chart_idstringrequired

Indiquez le graphique souhaité. Vous ne pouvez spécifier qu'un seul type de graphique par requête.

One of: "revenue", "mrr", "arr", "arppu", "subscriptions_active", "subscriptions_new", "subscriptions_renewal_cancelled", "subscriptions_expired", "trials_active", "trials_new", "trials_renewal_cancelled", "trials_expired", "grace_period", "billing_issue", "refund_events", "refund_money", "non_subscriptions", "arpu", "installs"

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

period_unitstring

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

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

date_typestring

Indiquez quelle date doit être considérée comme la date d'inscription de l'utilisateur

One of: "purchase_date", "profile_install_date"

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

Indiquez le format du fichier d'export

One of: "json", "csv"

Responses

Données analytiques récupérées avec succès

Schema

Réponse contenant les données analytiques pour le type de graphique demandé

dataobject

Objet contenant différents types de métriques (revenue, proceeds, net_revenue, etc.)

Example 
{
  "data": {
    "revenue": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": null
    },
    "proceeds": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": null
    },
    "net_revenue": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": 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 application, partagées par toutes les clés API de l'application.