Skip to content

Liste der Segmente exportieren

get

/segments/list

Verwenden Sie diesen Endpunkt, um eine Liste von Segmenten zu exportieren, die jeweils den Namen, den Segment-API-Bezeichner und die Angabe, ob Analytics-Tracking aktiviert ist, enthalten.

Die Segmente werden in Gruppen von 100 zurückgegeben, sortiert nach dem Zeitpunkt der Erstellung (standardmäßig vom ältesten zum neuesten). Archivierte Segmente sind nicht enthalten.

See me in Postman

Voraussetzungen

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

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
page Optional Integer Die Seite der zurückzugebenden Segmente, Standardwert ist 0 (gibt den ersten Satz von bis zu 100 zurück).
sort_direction Optional String - Erstellungszeit vom neuesten zum ältesten sortieren: Geben Sie den Wert desc an.
- Erstellungszeit vom ältesten zum neuesten sortieren: Geben Sie den Wert asc an.

Wenn sort_direction nicht angegeben ist, ist die Standardreihenfolge vom ältesten zum neuesten.

Beispielanfrage

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/segments/list?page=1&sort_direction=desc' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Antwort

1
2
3
4
5
6
7
8
9
10
11
12

{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "segments" : [
        {
            "id" : (string) the Segment API identifier,
            "name" : (string) segment name,
            "analytics_tracking_enabled" : (boolean) whether the segment has analytics tracking enabled,
            "tags" : (array) the tag names associated with the segment formatted as strings
        },
        ...
    ]
}
New Stuff!