List Alerts

GET /console/v1/alerts

Try it

List Alerts

cURL

curl --request GET \
  --url https://statsigapi.net/console/v1/alerts \
  --header 'STATSIG-API-KEY: <api-key>'

200

{
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "alertType": "threshold",
      "metrics": {},
      "metricGroupBys": {},
      "message": "<string>",
      "companyID": "<string>",
      "priority": "P0",
      "alertThreshold": 123,
      "windowMs": 123,
      "condition": "greater",
      "tags": [
        "<string>"
      ],
      "formula": "<string>",
      "creatorID": "<string>",
      "warningThreshold": 123,
      "renotificationConditions": [
        "raise"
      ],
      "renotificationWindowMs": 123,
      "renotificationMessage": "<string>",
      "team": "<string>"
    }
  ],
  "pagination": {
    "itemsPerPage": 123,
    "pageNumber": 123,
    "nextPage": "<string>",
    "previousPage": "<string>",
    "totalItems": 123,
    "all": "<string>"
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Query Parameters

creatorName · string | null

Name of the creator.

creatorID · string | null

ID of the user who created the entity.

tags

Filter by tags

limit · integer

Results per page

Example:

10

page · integer

Page number

Example:

1

Response

200

application/json

List Alerts success response

message · string · required

A simple string explaining the result of the operation.

data · object[] · required

Array of results returned by pagination limit.

Show child attributes

data. id · string · required

ID of the alert

data. name · string · required

Name of the alert

data. alertType · enum<string> · required

Type of alert

Available options: threshold

data. metrics · object · required

List of metrics associated with this alert

data. metricGroupBys · object · required

Metric groupbys

data. message · string · required

Alert message

data. companyID · string · required

data. priority · enum<string> · required

Priority of this alert

Available options: P0, P1, P2, P3, P4, P5

data. alertThreshold · number · required

data. windowMs · number · required

How far back and how frequently a metric should be checked, in milliseconds

data. condition · enum<string> · required

Condition under which a metric change triggers an alert in milliseconds

Available options: greater, greater_or_equal, less, less_or_equal, equal, not_equal

data. tags · string[] · required

Tags associated with this alert

data. formula · string

Formula for the alert

data. creatorID · string

data. warningThreshold · number

data. renotificationConditions · enum<string>[]

Condition under which a re-notification is sent

Available options: raise, warn, no-data

data. renotificationWindowMs · number

How long to wait before re-notifying in milliseconds

data. renotificationMessage · string

Re-notification message

data. team · string | null

Team associated with this alert

pagination · object · required

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

Show child attributes

pagination. itemsPerPage · number · required

pagination. pageNumber · number · required

pagination. nextPage · string | null · required

pagination. previousPage · string | null · required

pagination. totalItems · number

pagination. all · string