Exporter l’analyse de segment
get
/segments/data_series
Utilisez cet endpoint pour récupérer quotidiennement une série de la taille estimée d’un segment au fil du temps.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation segments.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 |
---|---|---|---|
segment_id |
Requis | Chaîne de caractères | Voir l’identifiant API du segment. Vous trouverez l’adresse segment_id pour un segment donné sur la page des clés API de votre compte Braze ou vous pouvez utiliser l’endpoint Exporter la liste des segments. |
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). |
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. |
Exemple de demande
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/segments/data_series?segment_id={{segment_identifier}}&length=14&ending_at=2018-06-27T23:59:59-5:00' \
--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,
"size" : (int) the size of the segment on that date
},
...
]
}
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!