Skip to content

Analytics angepasster Events exportieren

get

/events/data_series

Verwenden Sie diesen Endpunkt, um eine Reihe der Anzahl von Vorkommen eines angepassten Events in Ihrer App über einen bestimmten Zeitraum abzurufen.

See me in Postman

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung events.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
event Erforderlich String Der Name des angepassten Events, für das Analytics zurückgegeben werden sollen.
length Erforderlich Integer Maximale Anzahl der Einheiten (Tage oder Stunden) vor ending_at, die in die zurückgegebene Reihe aufgenommen werden sollen. Muss zwischen 1 und 100 (einschließlich) liegen.
unit Optional String Zeiteinheit zwischen Datenpunkten. Kann day oder hour sein, Standard ist day.
ending_at Optional Datetime
(ISO-8601-String)		 Datum, an dem die Datenreihe enden soll. Standardmäßig wird der Zeitpunkt der Anfrage verwendet.
app_id Optional String App-API-Bezeichner, der von der Seite API-Schlüssel abgerufen wird, um Analytics auf eine bestimmte App zu beschränken.
segment_id Optional String Siehe Segment-API-Bezeichner. Segment-ID, die das Analytics-aktivierte Segment angibt, für das Event-Analytics zurückgegeben werden sollen.

Beispielanfrage

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/events/data_series?event=event_name&length=24&unit=hour&ending_at=2014-12-10T23:59:59-05:00&app_id={{app_identifier}}&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,
    "data" : [
        {
            "time" : (string) the point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
            "count" : (int) the number of occurrences of provided custom event
        },
        ...
    ]
}

Antwortcodes bei schwerwiegenden Fehlern

Statuscodes und zugehörige Fehlermeldungen, die zurückgegeben werden, wenn Ihre Anfrage auf einen schwerwiegenden Fehler stößt, finden Sie unter Schwerwiegende Fehler und Antworten.
New Stuff!