Custom Events List

GET https://{{instance_url}}/events/list?page=3

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.

Response

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 CodeReason / Cause
400 Bad RequestBad Syntax
401 UnauthorizedUnknown or missing REST API Key
429 Rate LimitedOver rate limit
5XXInternal server error, you should retry with exponential backoff

Request Params

KeyDatatypeRequiredDescription
pagenumber(Optional) Integer

The page of event names to return, defaults to 0 (returns the first set of up to 250) |

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring