Exporter les informations relatives au segment
get
/segments/details
Utilisez cet endpoint pour récupérer des informations pertinentes sur un segment, qui peuvent être identifiées par le
segment_id
.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation segments.details
.
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. |
Exemple de demande
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/segments/details?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,
"created_at" : (string) the date created as ISO 8601 date,
"updated_at" : (string) the date last updated as ISO 8601 date,
"name" : (string) the segment name,
"description" : (string) a human-readable description of filters,
"text_description" : (string) the segment description,
"tags" : (array) the tag names associated with the segment formatted as strings,
"teams" : (array) the names of the Teams associated with the campaign
}
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!