Events (Console API)
A event refers to a notable occurrence in your product, such as a user signing up, unlocking an achievement, adding an item to a cart, or checking out. You can log these events using Statsig's SDKs with the logEvent API. This allows you to track user behaviors and responses to different variants of your experiments. The logged events can be visualized in the Metrics console and used for further analysis.
Event API functions
- Lineage: get metrics related to a given event
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
.
You can create or manage your keys here. To use the 'try it' section on this page, enter your Console API into the box below.
API Version
The Console API is versioned. Each version is guaranteed to not break existing usage; each new version introduces breaking changes. There is currently only one version: 20240601
.
Pass the version in the STATSIG-API-VERSION
field in the header. For now, this is optional; in the future, this will be required.