POST /api/v1/client-api/metrics/conversion/

Récupérer les données de conversion

Récupère les données de conversion pour analyser les actions des utilisateurs et mesurer l'efficacité des efforts marketing 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

from_periodstring | nullrequired

L'état d'abonnement de départ de l'utilisateur dans la conversion

to_periodstringrequired

Le nouvel état d'abonnement de l'utilisateur après la conversion

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 de conversion récupérées avec succès

Schema

Réponse contenant les données de conversion montrant la progression des utilisateurs entre les états d'abonnement

dataarray of object

Tableau de points de données de conversion (peut être vide pour les métriques agrégées)

valuenumber

La valeur du taux de conversion

value_frominteger

État d'abonnement de départ pour la conversion

value_tointeger

État d'abonnement cible pour la conversion

compare_value_fromnumber

Valeur de début pour la période de comparaison

compare_value_tonumber

Valeur de fin pour la période de comparaison

titlestring

Titre d'affichage décrivant le type de conversion

typestring

Type de métrique de conversion

default_aggregationstring

Méthode d'agrégation par défaut pour cette métrique

descriptionstring

Explication détaillée du mode de calcul du taux de conversion

metric_namestring

Nom interne de la métrique de conversion

is_jsonboolean

Indique si les données sont au format JSON

unitstring

Unité de mesure (généralement 'percent' pour les taux de conversion)

recommended_periodobject

Plage de dates recommandée pour cette métrique de conversion

date_fromstring

Date de début de la période recommandée

date_tostring

Date de fin de la période recommandée

period_unitstring

Unité de période recommandée

Example

{
  "data": [],
  "value": 0,
  "value_from": 0,
  "value_to": 0,
  "compare_value_from": null,
  "compare_value_to": null,
  "title": "Conversion rate from Paid to more than 6 months",
  "type": "multi",
  "default_aggregation": "sum",
  "description": "If Х - the number of the 1st payments taken during the selected date, and Y - the amount of the renewals that happened after the 6 months since the selected date from those 1st payments, then Conversion = (Y / X) * 100%. For example, we had 100 1st subscriptions of various products on the 1st of January and among them 20 renewed on the 1st week of July (the 25th payment). On the 8th of July, we open the chart and see the conversion of the 1st of January = (20 / 100) * 100% = 20%. Then 30 more subscribers of the 1st of January renewed by the start of August (the 8th payment). We open the chart on the 1st of August and see that the conversion of the 1st of January = ((20+30) / 100) * 100% = 50%. This number shows which part of those who had their 1st payment on the 1st of January converted to the period > 6 months with any number of payments by the current moment.",
  "metric_name": "from_paid_to_6_months_conversion",
  "is_json": true,
  "unit": "percent",
  "recommended_period": {
    "date_from": "2018-04-29",
    "date_to": "2024-12-31",
    "period_unit": "month"
  }
}

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.

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ]
      },
      "from_period": 1,
      "to_period": "6+",
      "period_unit": "month",
      "date_type": "purchase_date",
      "segmentation": "country",
      "format": "json"
    })
data = response.json()