List Alerts

GET /console/v1/alerts

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>",
      "alertThreshold": 123,
      "windowMs": 123,
      "tags": [
        "<string>"
      ],
      "formula": "<string>",
      "creatorID": "<string>",
      "warningThreshold": 123,
      "renotificationConditions": [],
      "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 · string string[]

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

pagination · object · required

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

Show child attributes