Skip to content

Exporter l’analyse de segment

get

/segments/data_series

Utilisez cet endpoint pour récupérer une série quotidienne de la taille estimée d’un segment au fil du temps.

Si vous avez besoin de la taille exacte d’un segment, exportez ses utilisateurs avec l’endpoint /users/export/segment et comptez les profils exportés.

See me in Postman

Conditions préalables

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

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Paramètres de requête

Paramètre Requis Type de données Description
segment_id Requis Chaîne de caractères Voir Identifiant API de segment.

Le segment_id d’un segment donné se trouve sur la page 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, correspond à l’heure de la requête.

Exemple de requête

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

{
    "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
        },
        ...
    ]
}
New Stuff!