Skip to main content
GET
/
console
/
v1
/
events
List Events
curl --request GET \
  --url https://statsigapi.net/console/v1/events \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Event values listed successfully.",
  "data": [
    {
      "timestamp": "1720567284328",
      "name": "time_spent_on_page",
      "source": "statsig-node",
      "value": "463",
      "userID": "1922",
      "metadata": {}
    },
    {
      "timestamp": "1720567284328",
      "name": "add_to_cart",
      "source": "statsig-node",
      "value": "appliances",
      "userID": "1922",
      "metadata": {}
    },
    {
      "timestamp": "1720567284321",
      "name": "time_spent_on_page",
      "source": "statsig-node",
      "value": "421",
      "userID": "1026",
      "metadata": {}
    },
    {
      "timestamp": "1720567284321",
      "name": "add_to_cart",
      "source": "statsig-node",
      "value": "electronics",
      "userID": "1026",
      "metadata": {}
    },
    {
      "timestamp": "1720567284485",
      "name": "time_spent_on_page",
      "source": "statsig-node",
      "value": "273",
      "userID": "8455",
      "metadata": {}
    }
  ],
  "pagination": {
    "itemsPerPage": 5,
    "pageNumber": 1,
    "totalItems": 1000,
    "nextPage": "/console/v1/events?page=2&limit=5",
    "previousPage": null,
    "all": "/console/v1/events"
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Query Parameters

​
limit
integer

Results per page

Example:

10

​
page
integer

Page number

Example:

1

Response

List Events response

​
message
string
required

A simple string explaining the result of the operation.

​
data
object[]
required

Array of results returned by pagination limit.

​
pagination
object
required

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