DocumentationDiscussions
DocumentationDiscussions

Alert Properties

Alerts (including templated email notifications) can include the following fields:

Property

Contains

Example

AlertId

The id of the alert that triggered the notification

"alert-1234"

AlertRangeEnd

An ISO-8601 date-time representing the (exclusive) end of the time range that triggered the alert

"2020-01-02T13:45:56"

AlertRangeStart

An ISO-8601 date-time representing the (inclusive) start of the time range that triggered the alert

"2019-01-02T13:45:56"

AlertTitle

The title of the alert, as defined on the dashboard

"High Error Rate"

ChartTitle

The title of the dashboard chart to which the alert is attached

"Errors in Ordering"

Condition

The alert condition

"count > 10"

DashboardId

The id of the dashboard that contains the alert

"dashboard-1234"

DashboardTitle

The title of the dashboard that contains the alert

"Ordering Systems"

DashboardUrl

A fully-qualified URL at which the dashboard can be viewed

"http://seq.example.com/#/dashboards/dashboard-1234"

Failed

A Boolean that signals whether alert checking failed; if true, see Errors

false

Errors

An array of errors that occurred when checking the alert

["X failed", "Y failed"]

MeasurementWindow

The duration of the measurement window, as a time span

"00:30:00"

OwnerId

The owner of the dashboard containing the alert, or null

"user-1234"

OwnerDisplayName

The owner's display name

"Alice Example"

OwnerUsername

The owner's username

"[email protected]"

Query

The SQL query that was used to compute the alert results

"select ..."

Results

A structured object with result values

{ ... }

ResultsUrl

A URL at which the results of the triggering SQL query can be viewed

"http://seq.example.com/#/events?q=..."

SignalExpression

The signal expression over which the alert was computed

"signal-1234|signal-4567"

SuppressionTime

The time for which notifications will be suppressed after this one

"01:00:00"


Did this page help you?