List Events

Returns recently logged events across all event names in your project. Results cover a limited rolling window of recent traffic, not full event history. limi…

Returns recently logged events across all event names in your project. Results cover a limited rolling window of recent traffic, not full event history. limit and page paginate only within the returned set; totalItems is the size of that set, not lifetime event volume.

gethttps://statsigapi.net/console/v1/events

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

Example:10
Constraints:stringnumber
pageinteger

Page number

Example:1
Constraints:stringnumber

Response

application/json
200· List Events response. pagination.totalItems is the number of recent events in the current result set, not total events ever logged.
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
timestampstringrequired

The timestamp when the event occurred, represented as a string.

namestringrequired

The name of the event (e.g., "add_to_cart").

sourcestringrequired

The source of the event, indicating where it was triggered from.

valuestringrequired

The value associated with the event, providing additional context.

userIDstringrequired

The ID of the user who triggered the event.

paginationobjectrequired

Pagination metadata for checking if there is next page for example.

Show child attributes
itemsPerPagenumberrequired
Constraints:format: double
pageNumbernumberrequired
Constraints:format: double
nextPagestringrequired
Constraints:nullable
previousPagestringrequired
Constraints:nullable
totalItemsnumber
Constraints:format: double
allstring
400· Invalid request. Please check the request input and try again.
statusintegerrequired
Allowed values:400
messagestringrequired
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
Allowed values:401
messagestringrequired

Was this helpful?