Get Triggered Alerts

Request Arguments

FieldTypeDescription / Example
startTimeintegerRetrieve alerts that started after this time (epoch).
orderenumSort order: {asc, desc}.
sortenumSort field: {startTime, updateTime, duration, score, metrics}.
labelsstringFilter alerts by labels.
typesenumAlert types. One or more of: {anomaly, static, noData}.
channelsstringComma-separated list of channel IDs to which the alerts were sent.
severitiesenumAlert severities. One or more of: {INFO, LOW, MEDIUM, HIGH, CRITICAL}.
statusenumAlert status: {OPEN, CLOSE}.
sizeintegerMaximum number of triggers to return. Default: 20.
alertConfigurationIdsstringFilter triggers by a specific alert configuration ID.
isLeanResponsebooleanOptional (default: true). If set to false, the response includes full trigger data, including the metrics array.

ℹ️

If metric-level data is not required, keep the isLeanResponse parameter set to true. The response will include only trigger metadata and will be significantly smaller.

If metric-level details are needed, set isLeanResponse to false to retrieve the full response, including metric data.

Response Fields:

FieldTypeDescription / Example
totalnumberTotal number of alert triggers matching the criteria.
alertsarrayArray of alert triggers matching the search criteria.
idstringAlert trigger ID.
timescaleenumTimescale of the alert: {1m, 5m, 1d, 1w}.
typeenumType of alert: {anomaly, static, no_data}.
statusenumTrigger status: {OPEN, UPDATE, CLOSE}.
groupIdstringIdentifier for correlated triggers (Alert Group).
alertConfigurationIdstringID of the alert configuration that generated this trigger.
titlestringTrigger title (dynamically generated based on metrics).
descriptionstringDescription of the alert.
severityenumAlert severity.
startTimeepochTime when the anomaly started.
updateTimeepochTime when the anomaly was last updated.
endTimeepochTime when the anomaly ended and the alert was closed.
triggerTimeepochTime when the alert was triggered. Can be used to calculate TTD (triggerTime − startTime).
dispatchTimeepochSystem time when the alert was sent.
acknowledgeTimeepochTime of the first acknowledgment of this alert trigger.
durationintegerDuration of the anomaly (in seconds).
channelsarrayChannels to which this trigger was sent.
subscribersarrayUser IDs subscribed to this alert.
totalMetricsintegerNumber of metrics in this trigger.
assigneestringUser ID of the assigned user; null if unassigned.
impactEligiblebooleanIndicates whether this alert supports Business Impact analysis.
labelsarrayLabels assigned to the alert.
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json