Metrics
Read Single Metric Value
HTTP API
Console API
Alerts
Audit Logs
Autotunes
Company
Dynamic Configs
- GETList Dynamic Configs
- POSTCreate Dynamic Config
- GETGet Dynamic Config
- POSTFully Update Dynamic Config
- DELDelete Dynamic Config
- PATCHPartially Update Dynamic Config
- PUTDisable Dynamic Config
- PUTEnable Dynamic Config
- POSTAdd Dynamic Config Rule
- GETGet Specific Dynamic Config Rule
- DELDelete Dynamic Config Rule
- PATCHUpdate Dynamic Config Rule By Id
- DELDelete Dynamic Config Rule By Name
- PATCHUpdate Dynamic Config Rule By Name
- GETGet Dynamic Config Rules
- POSTAdd Dynamic Config Rules
- PATCHUpdate List of Dynamic Config Rules
- GETList Dynamic Config Versions
Experiments
- GETList Experiments
- POSTCreate Experiment
- GETGet Experiment
- POSTFully Update Experiment
- DELDeleted Experiment
- PATCHPartially Update Experiment
- PUTAbandon Experiment
- PUTArchive Experiment
- GETRetrieve cumulative exposures
- POSTDisable Experiment Groups
- POSTEnable Experiment Groups
- PUTFinish Experiment Early
- GETGet Experiment Overrides
- POSTUpdate Experiment Overrides
- DELDelete Experiment Overrides
- PATCHPartially Update Experiment Overrides
- GETRetrieve Pulse Results (Beta)
- PUTReset Experiment
- PUTStart Experiment
- PUTUnarchive Experiment
Experiments (Warehouse Native)
- POSTLoad Pulse (Warehouse Native)
- GETPulse Load History (Warehouse Native)
- POSTPost Assignment Source
- DELDelete Assignment Source
- PATCHPatch Assignment Source
- GETList Assignment Sources
- POSTCreate Assignment Source
- GETList Entity Property Sources
- POSTCreate Entity Property Source
- GETGet Entity Property Source
- POSTPost Entity Property Source
- DELDelete Entity Property Source
- PATCHPatch Entity Property Source
Configs
Gates
- GETList Gates
- POSTCreate Gate
- GETRead Gate
- POSTFully Update Gates
- DELDelete Gates
- PATCHPartially Update Gates
- PUTArchive Gate
- PUTDisable Gate
- PUTEnable Gate
- PUTLaunch Gate
- POSTLoad Pulse Gate
- GETGet Gate Override
- POSTUpdate Gate Overrides
- DELDelete Gate Overrides
- PATCHAdd Gate Overrides
- POSTAdd Gate Rule
- GETRead Gate Rules
- POSTAdd Multiple Gate Rule
- PATCHUpdate list of current Gate Rules settings
- DELDelete Gate Rule
- PATCHUpdate Gate Rules
- GETPulse Load History (Warehouse Native)
- GETRetrieve Pulse Results (Beta)
- GETList Gate Versions
Holdouts
Ingestions
- GETRead Ingestion
- POSTCreate Ingestion Source
- DELDelete Ingestion Source
- PATCHUpdate Ingestion Source
- POSTBackfill Ingestion
- POSTCreate Ingestion Databricks
- GETGet Ingestion Event Count
- GETGet Ingestion Event Delta Ledger
- GETList Ingestion Runs
- GETRead Ingestion Run
- GETRead Ingestion Schedule
- POSTUpdate Ingestion Schedule
- GETList Ingestions Status
Keys
Layers
Metrics
Metrics (Warehouse Native)
Project
Reports
Segments
Target App
Users
- GETList Users
- GETGet user by email
- POSTUpdate user
- POSTInvite user. To avoid spamming, invitation emails are not sent. Invitee will see invitation notification in-app after logging in.
- GETList Teams
- POSTCreate Team
- GETGet Team
- DELDelete Team
- PATCHUpdate Team. Ops: Replace. Use GET for current data if you intent to Add.
Metrics
Read Single Metric Value
GET
/
console
/
v1
/
metrics
Copy
curl --request GET \
--url https://statsigapi.net/console/v1/metrics \
--header 'STATSIG-API-KEY: <api-key>'Copy
{
"message": "Metric read successfully.",
"data": [
{
"value": 0,
"unit_type": "overall",
"numerator": null,
"denominator": null,
"metric_name": "TestMetricCapi",
"metric_type": "sum"
},
{
"value": 0,
"unit_type": "userID",
"numerator": null,
"denominator": null,
"metric_name": "TestMetricCapi",
"metric_type": "sum"
}
]
}Authorizations
Headers
Optional header to respect review settings for mutation endpoints.
Response
200
application/json
Get metric data on given date response
A simple string explaining the result of the operation.
Array of results returned by pagination limit.
Metric value for the given unit_type
Unit of the metric: stableID, userID, and other custom ids
Row count for imported metric, optional
Numerator of a ratio metric, optional
Denominator of a ratio metric, optional
Copy
curl --request GET \
--url https://statsigapi.net/console/v1/metrics \
--header 'STATSIG-API-KEY: <api-key>'Copy
{
"message": "Metric read successfully.",
"data": [
{
"value": 0,
"unit_type": "overall",
"numerator": null,
"denominator": null,
"metric_name": "TestMetricCapi",
"metric_type": "sum"
},
{
"value": 0,
"unit_type": "userID",
"numerator": null,
"denominator": null,
"metric_name": "TestMetricCapi",
"metric_type": "sum"
}
]
}