Get Custom Events List
/events/list
This endpoint allows you to export a list of custom events that have been recorded for your app. The event names are returned in groups of 250, sorted alphabetically.
Looking for the api_key
parameter?
As of May 2020, Braze has changed how we read API keys to be more secure. Now API keys must be passed as a request header, please see YOUR_REST_API_KEY
within the Example Request below.
Braze will continue to support the api_key
being passed through the request body and URL parameters, but will eventually be sunset. Please update your API calls accordingly.
Request Parameter
Parameter | Required | Data Type | Description |
---|---|---|---|
page |
No | Integer | The page of event names to return, defaults to 0 (returns the first set of up to 250) |
Example URL
https://rest.iad-01.braze.com/events/list?page=3
Example Request
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/events/list?page=3' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'
Response
1
2
3
4
5
6
7
8
9
10
11
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"events" : [
"Event A",
"Event B",
"Event C",
...
]
}
Fatal Error Response Codes
The following status codes and associated error messages will be returned if your request encounters a fatal error. Any of these error codes indicate that no data will be processed.
Error Code | Reason / Cause |
---|---|
400 Bad Request | Bad Syntax |
401 Unauthorized | Unknown or missing REST API Key |
429 Rate Limited | Over rate limit |
5XX | Internal server error, you should retry with exponential backoff |
For help with CSV and API exports, visit our troubleshooting article here.