Skip to content

Segmentdetails exportieren

get

/segments/details

Verwenden Sie diesen Endpunkt, um relevante Informationen zu einem Segment abzurufen, das anhand der segment_id identifiziert werden kann.

See me in Postman

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung segments.details.

Rate-Limit

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfrageparameter

Parameter Erforderlich Datentyp Beschreibung
segment_id Erforderlich String Siehe Segment-API-Bezeichner.

Die segment_id für ein bestimmtes Segment finden Sie auf der Seite API-Schlüssel in Ihrem Braze-Konto, oder Sie können den Endpunkt „Segmentliste exportieren“ verwenden.

Beispielanfrage

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'

Antwort

1
2
3
4
5
6
7
8
9
10

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