Skip to content

Exporter les données de chiffre d’affaires par période

get

/purchases/revenue_series

Utilisez cet endpoint pour renvoyer le montant total dépensé dans votre application sur une plage de temps.

See me in Postman

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation purchases.revenue_series.

Limite de débit

Nous appliquons une limite de débit partagée de 1 000 requêtes par heure à cet endpoint. Cette limite de débit est partagée avec les endpoints /custom_attributes, /events et /events/list, comme documenté dans Limites de débit de l’API.

Paramètres de requête

Paramètre Requis Type de données Description
ending_at Facultatif Datetime (chaîne de caractères ISO-8601) Date à laquelle l’exportation de données doit se terminer. Par défaut, correspond à l’heure de la requête.
length Requis Entier Nombre maximum de jours avant ending_at à inclure dans la série renvoyée. Doit être compris entre 1 et 100 (inclus).
unit Facultatif Chaîne de caractères Unité de temps entre les points de données. Peut être « day » ou « hour », la valeur par défaut étant « day ».
app_id Facultatif Chaîne de caractères Identifiant API de l’application récupéré à partir de la page Clés API. Si ce paramètre est omis, les résultats de toutes les applications de l’espace de travail seront renvoyés.
product Facultatif Chaîne de caractères Nom du produit par lequel filtrer la réponse. Si ce paramètre est omis, les résultats de toutes les applications seront renvoyés.

Exemple de requête

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/purchases/revenue_series?length=100' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Réponse

1
2
3
4
5
6
7
8
9
10

{
  "message": (required, string) the status of the export, returns 'success' when completed without errors,
  "data" : [
    {
      "time" : (string) the date as ISO 8601 date,
      "revenue" : (int) amount of revenue for the time period
      },
    ...
  ]
}
New Stuff!