Skip to content

Segment-Analytics exportieren

get

/segments/data_series

Verwenden Sie diesen Endpunkt, um eine tägliche Serie der geschätzten Größe eines Segments im Laufe der Zeit abzurufen.

Wenn Sie die exakte Größe eines Segments benötigen, exportieren Sie dessen Nutzer:innen mit dem /users/export/segment-Endpunkt und zählen Sie die exportierten Profile.

Voraussetzungen

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

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.
length Erforderlich Integer Maximale Anzahl der Tage vor ending_at, die in der zurückgegebenen Serie enthalten sein sollen. Muss zwischen 1 und 100 (einschließlich) liegen.
ending_at Optional Datetime
(ISO-8601-String)
Datum, an dem die Datenreihe enden soll. Standardmäßig wird der Zeitpunkt der Anfrage verwendet.

Beispielanfrage

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'

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,
    "data" : [
        {
            "time" : (string) the date as ISO 8601 date,
            "size" : (int) the size of the segment on that date
        },
        ...
    ]
}
New Stuff!