Classic ASP / Braze Endpoints / Custom Events List
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
set http = Server.CreateObject("Chilkat_9_5_0.Http")
set queryParams = Server.CreateObject("Chilkat_9_5_0.JsonObject")
success = queryParams.UpdateInt("page",3)
' Adds the "Authorization: Bearer {{api_key}}" header.
http.AuthToken = "{{api_key}}"
' resp is a Chilkat_9_5_0.HttpResponse
Set resp = http.QuickRequestParams("GET","https://rest.iad-01.braze.com/events/list",queryParams)
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
Response.Write "<pre>" & Server.HTMLEncode( resp.StatusCode) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.BodyStr) & "</pre>"
%>
</body>
</html>
Curl Command
curl -G -d "page=3"
-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/events/list
Postman Collection Item JSON
{
"name": "Custom Events List",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"type": "text"
}
],
"url": {
"raw": "https://{{instance_url}}/events/list?page=3",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"events",
"list"
],
"query": [
{
"key": "page",
"value": "3",
"description": "(Optional) Integer\n\nThe page of event names to return, defaults to 0 (returns the first set of up to 250)"
}
]
},
"description": "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.\n\n\n## Response\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n \"message\": (required, string) the status of the export, returns 'success' when completed without errors,\n \"events\" : [\n \"Event A\",\n \"Event B\",\n \"Event C\",\n ...\n ]\n}\n```\n\n### Fatal Error Response Codes\n\nThe 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.\n\n| Error Code | Reason / Cause |\n| ---------------- | ---------------------------------------------------------------- |\n| 400 Bad Request | Bad Syntax |\n| 401 Unauthorized | Unknown or missing REST API Key |\n| 429 Rate Limited | Over rate limit |\n| 5XX | Internal server error, you should retry with exponential backoff |"
},
"response": [
]
}
