List Topline Alerts

gethttps://statsigapi.net/console/v1/alerts

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

pageinteger

Page number

Response

application/json

200· List Alerts success response

messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required

Show child attributes

id[]stringrequired

ID of the alert

name[]stringrequired

Name of the alert

alertType[]stringrequired

Type of alert

metrics[]objectrequired

List of metrics associated with this alert

metricGroupBys[]objectrequired

Metric groupbys

formula[]string

Formula for the alert

message[]stringrequired

Alert message

creatorID[]string

companyID[]stringrequired

priority[]stringrequired

Priority of this alert

alertThreshold[]numberrequired

warningThreshold[]number

windowMs[]numberrequired

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

condition[]stringrequired

Condition under which a metric change triggers an alert in milliseconds

renotificationConditions[]string[]

Condition under which a re-notification is sent

renotificationWindowMs[]number

How long to wait before re-notifying in milliseconds

renotificationMessage[]string

Re-notification message

team[]string

Team associated with this alert

tags[]string[]required

Tags associated with this alert

paginationobjectrequired

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

403· Forbidden resource

statusnumberrequired

messagestringrequired

Was this helpful?