Skip to content

Angepasste Events exportieren

get

/events

Verwenden Sie diesen Endpunkt, um eine Liste der angepassten Events zu exportieren, die für Ihre App aufgezeichnet wurden. Die Events werden in Gruppen von 50, alphabetisch sortiert, zurückgegeben.

Voraussetzungen

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

Rate-Limit

Wir wenden auf diesen Endpunkt ein gemeinsames Rate-Limit von 1.000 Anfragen pro Stunde an. Dieses Rate-Limit wird mit den Endpunkten /custom_attributes, /events/list und /purchases/product_list geteilt, wie in API-Rate-Limits dokumentiert.

Abfrageparameter

Beachten Sie, dass jeder Aufruf dieses Endpunkts 50 Events zurückgibt. Bei mehr als 50 Events verwenden Sie den Link-Header, um die Daten auf der nächsten Seite abzurufen, wie in der folgenden Beispielantwort gezeigt.

Parameter Erforderlich Datentyp Beschreibung
cursor Optional String Bestimmt die Paginierung der angepassten Events.

Beispielanfragen

Ohne Cursor

1
2
3
curl --location --request GET 'https://rest.iad-01.braze.com/events' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Mit Cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/events?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Antwort

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "events" : [
        {
            "name": "The event name", (string) the event name,
            "description": "The event description", (string) the event description,
            "included_in_analytics_report": false, (boolean) the analytics report inclusion,
            "status": "Active", (string) the event status,
            "tag_names": ["Tag One", "Tag Two"] (array) the tag names associated with the event formatted as strings,
        },
        ...
    ]
}

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.

New Stuff!