Exporter l’analyse d’événements personnalisés
get
/events/data_series
Utilisez cet endpoint pour récupérer une série du nombre d’occurrences d’un événement personnalisé dans votre application sur une période donnée.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation events.data_series
.
Limite de débit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Paramètres de demande
Paramètre | Requis | Type de données | Description |
---|---|---|---|
event |
Requis | Chaîne de caractères | Le nom de l’événement personnalisé pour lequel renvoyer l’analyse. |
length |
Requis | Entier | Nombre maximum d’unités (jours ou heures) 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 , valeur par défaut day . |
ending_at |
Facultatif | DateTime chaîne (ISO-8601) |
Date à laquelle la série de données doit se terminer. Par défaut, l’heure de la demande. |
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 pour limiter l’analyse/analytique à une application spécifique. |
segment_id |
Facultatif | Chaîne de caractères | Voir l’identifiant API du segment. ID de segment indiquant le segment à analyser pour lequel l’analyse d’événement doit être renvoyée. |
Exemple de demande
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/events/data_series?event=event_name&length=24&unit=hour&ending_at=2014-12-10T23:59:59-05:00&app_id={{app_identifier}}&segment_id={{segment_identifier}}' \
--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 point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
"count" : (int) the number of occurrences of provided custom event
},
...
]
}
Codes de réponse des erreurs fatales
Pour les codes d’état et les messages d’erreur associés qui seront renvoyés si votre demande rencontre une erreur fatale, consultez Erreurs fatales et réponses.
tip:
Pour obtenir de l’aide sur les exportations CSV et de l’API, consultez la section Résolution des problèmes d’exportation.
New Stuff!