Update Topline Alert

patchhttps://statsigapi.net/console/v1/alerts/{id}

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

id

Body

application/json
namestring

Name of the alert (4-100 characters)

messagestring

Alert message shown when the alert fires

alertThresholdnumber

Threshold value that triggers the alert

warningThresholdnumber

Optional warning threshold value. Pass null to clear.

formulastring

Formula expression. Pass null to clear.

windowMsnumber

How far back and how frequently a metric should be checked, in milliseconds. Must be between 60_000 and 30 days.

conditionstring

Condition under which a metric change triggers an alert

prioritystring

Alert priority

renotificationConditionsstring[]

Conditions under which a re-notification is sent. Pass null to clear.

renotificationWindowMsnumber

How long to wait before re-notifying, in ms

renotificationMessagestring

Re-notification message

Response

application/json
200· Update Alert success response
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
Show child attributes
idstringrequired

ID of the alert

namestringrequired

Name of the alert

alertTypestringrequired

Type of alert

metricsobjectrequired

List of metrics associated with this alert

metricGroupBysobjectrequired

Metric groupbys

formulastring

Formula for the alert

messagestringrequired

Alert message

creatorIDstring
companyIDstringrequired
prioritystringrequired

Priority of this alert

alertThresholdnumberrequired
warningThresholdnumber
windowMsnumberrequired

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

conditionstringrequired

Condition under which a metric change triggers an alert in milliseconds

renotificationConditionsstring[]

Condition under which a re-notification is sent

renotificationWindowMsnumber

How long to wait before re-notifying in milliseconds

renotificationMessagestring

Re-notification message

teamstring

Team associated with this alert

tagsstring[]required

Tags associated with this alert

statusstringrequired

Current evaluation status of the alert

lastTriggeredTimenumberrequired

Timestamp in milliseconds of the last time this alert triggered

403· Forbidden resource
statusnumberrequired
messagestringrequired
404· Not Found. The requested resource could not be found.
statusintegerrequired
messagestringrequired

Was this helpful?