Exporter les données des chiffres d’affaires par période
get
/purchases/revenue_series
Utilisez cet endpoint pour renvoyer l’argent total dépensé dans votre application sur une plage de temps.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation purchases.revenue_series.
Limite de débit
We apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the /custom_attributes, /events, and /events/list endpoints, as documented in API rate limits.
Paramètres de demande
| Paramètre | Requis | Type de données | Description |
|---|---|---|---|
ending_at |
Facultatif | Datetime( chaîne de caractèresISO-8601 ) | Date à laquelle l’exportation de données doit se terminer. Par défaut, l’heure de la demande. |
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. Il peut s’agir d’un jour ou d’une heure, la valeur par défaut étant le jour. |
app_id |
Facultatif | Chaîne de caractères | Identifiant de l’API de l’application récupéré à partir de la page Clés API. En cas d’exclusion, les résultats de toutes les applications d’un espace de travail seront renvoyés. |
product |
Facultatif | Chaîne de caractères | Nom du produit par lequel filtrer les réponses. En cas d’exclusion, les résultats de toutes les applications seront renvoyés. |
Exemple de demande
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
11
12
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"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
},
...
]
}
tip:
Pour obtenir de l’aide sur les exportations CSV et de l’API, consultez la section Résolution des problèmes d’exportation.
Modifier cette page sur GitHub
CETTE PAGE A-T-ELLE ÉTÉ UTILE?
New Stuff!