Cette page a été traduite automatiquement et peut contenir des inexactitudes. Pour signaler une erreur de traduction, ouvrez un ticket sur GitHub.
Exporter le nombre d’achats
get
/purchases/quantity_series
Utilisez cet endpoint pour renvoyer le nombre total d’achats 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.quantity_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, 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/quantity_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,
"purchase_quantity" : (int) the number of items purchased in the time period
},
...
]
}

Conseil
Pour obtenir de l’aide sur les exportations CSV et API, consultez la section Résolution des problèmes d’exportation.
New Stuff!