Alerts
List Alerts
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.
Alerts
List Alerts
GET
/
console
/
v1
/
alerts
curl --request GET \
--url https://statsigapi.net/console/v1/alerts \
--header 'STATSIG-API-KEY: <api-key>'{
"message": "<string>",
"data": [
{
"id": "<string>",
"name": "<string>",
"alertType": "threshold",
"metrics": {},
"metricGroupBys": {},
"formula": "<string>",
"message": "<string>",
"creatorID": "<string>",
"companyID": "<string>",
"priority": "P0",
"alertThreshold": 123,
"warningThreshold": 123,
"windowMs": 123,
"condition": "greater",
"renotificationConditions": [
"raise"
],
"renotificationWindowMs": 123,
"renotificationMessage": "<string>",
"team": "<string>",
"tags": [
"<string>"
]
}
],
"pagination": {
"itemsPerPage": 123,
"pageNumber": 123,
"nextPage": "<string>",
"previousPage": "<string>",
"totalItems": 123,
"all": "<string>"
}
}Authorizations
Headers
Optional header to respect review settings for mutation endpoints.
Query Parameters
Name of the creator.
ID of the user who created the entity.
Filter by tags
Results per page
Example:
10
Page number
Example:
1
Response
200
application/json
List Alerts success response
A simple string explaining the result of the operation.
Array of results returned by pagination limit.
ID of the alert
Name of the alert
Type of alert
Available options:
threshold List of metrics associated with this alert
Metric groupbys
Alert message
Priority of this alert
Available options:
P0, P1, P2, P3, P4, P5 How far back and how frequently a metric should be checked, in milliseconds
Condition under which a metric change triggers an alert in milliseconds
Available options:
greater, greater_or_equal, less, less_or_equal, equal, not_equal Tags associated with this alert
Formula for the alert
Condition under which a re-notification is sent
Available options:
raise, warn, no-data How long to wait before re-notifying in milliseconds
Re-notification message
Team associated with this alert
curl --request GET \
--url https://statsigapi.net/console/v1/alerts \
--header 'STATSIG-API-KEY: <api-key>'{
"message": "<string>",
"data": [
{
"id": "<string>",
"name": "<string>",
"alertType": "threshold",
"metrics": {},
"metricGroupBys": {},
"formula": "<string>",
"message": "<string>",
"creatorID": "<string>",
"companyID": "<string>",
"priority": "P0",
"alertThreshold": 123,
"warningThreshold": 123,
"windowMs": 123,
"condition": "greater",
"renotificationConditions": [
"raise"
],
"renotificationWindowMs": 123,
"renotificationMessage": "<string>",
"team": "<string>",
"tags": [
"<string>"
]
}
],
"pagination": {
"itemsPerPage": 123,
"pageNumber": 123,
"nextPage": "<string>",
"previousPage": "<string>",
"totalItems": 123,
"all": "<string>"
}
}