OpenAPI Specification

We are updating our Console API (CAPI) documentation to align with the OpenAPI specification. This transition will enable you to generate client libraries in your preferred language, test API endpoints, and interactively explore the API.

The endpoints below are the latest and auto-generated. While we strive to provide comprehensive descriptions and examples for each endpoint during this migration, if you notice any missing information or have feedback, please reach out to us on Slack.

Authorization

All requests must include the STATSIG-API-KEY field in the header. The value should be a Console API Key which can be created in Project Settings > API Keys tab.
To use the 'Try' function on this page, enter your Console API into the box below.

You will be directly modifying the project connected to the api-key provided. We suggest creating a temporary project when testing our API below.

Pagination parameters required from August 1st, 2024

List requests without page and limit parameters will default to page=1&limit=100.

a wild CAPIbara appeared