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

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

Copy as Markdown

Récupère les données d'analyse pour obtenir des informations sur le comportement des utilisateurs et les métriques de performance, afin de les utiliser dans des graphiques.

Les revenus de cet endpoint sont basés sur les événements : chaque valeur est attribuée à la date de la 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 réconcilier 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 dont vous avez besoin. 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

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"

date_typestring

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

One of: "purchase_date", "profile_install_date"

segmentationstring

Définit la base de la segmentation

formatstring

Indiquez le format de fichier d'export

One of: "json", "csv"

Responses

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

Schema

Réponse contenant les données d'analyse 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 clé API.