Get alert details

Response body

object

activity

array of objects

Activity information.

activity

object

messageArgs

object

Specifies additional information that may be useful in adding detail to the message.

Has additional fields

messageKey

string

required

Internationalization token or message to present to users.

time

date-time

required

An ISO 8601 timestamp.

alerts

array of objects

required

length ≥ 1

Alert firings.

alerts*

object

definitionId

string

required

length ≥ 1

Identifies the alert definition.

endTime

date-time | null

required

ISO 8601 timestamp for the period ending when the alert fired, corresponding to startTime. The value is null if the alert is currently firing.

fieldMap

object

required

A free-form object that captures details on state when the alert triggered, akin to a stack trace.

Has additional fields

firingId

string

required

length ≥ 1

Identifies the alert firing.

name

string

required

length ≥ 1

Name of the alert that fired.

service

string

required

length ≥ 1

Identifies the back-end service provider that fired the alert.

startTime

date-time

required

ISO 8601 timestamp for the period starting when the alert fired, corresponding to endTime.

definition

object

required

Alert configured with thresholds for monitoring.

accountId

string

length ≥ 1

Identifies the account under which the alert was created.

definitionId

string

length ≥ 1

Identifies the alert definition.

editInfo

object

A summary of the alert's creation time and most recent edit.

fields

object

required

The set of criteria that determines when the alert fires. The object's members vary depending on the template on which the alert is based. However, all fields include a name, the templateId on which the alert was based, and an array of email addresses for the alert's recipients.

links

array of objects

length ≥ 2

Link relations to schemas and REST endpoints.

links

object

href

string

required

length ≥ 1

Link to resource of type described by rel.

rel

string

required

length ≥ 1

Describes type of link.

origin

string

Identifies the type of alert the template enables, either STATIC or ADAPTIVE. Static alert types specify raw values, while the adaptive alert type expresses standard deviations. The only available ADAPTIVE alert identifies excessive traffic, and its templateId is a@1.

STATIC ADAPTIVE

definitionId

string

required

length ≥ 1

Identifies the alert definition.

scopes

array of strings

length ≥ 1

The set of your permissions to modify the alert, any combination of: ALERTS_READ, ALERTS_ADD, ALERTS_DELETE, ALERTS_EDIT, and ALERTS_VIEWER values. The 'ALERTS_READ' permission lets you view alert configuration. The 'ALERTS_VIEWER' permission lets you view active alerts.

scopes

sparkline

object | null

JSON used to represent graph data. The amount of data varies depending on the supplied parameters.

anomalies

array of objects

required

length ≥ 0

Lists alert firings that occur within the report's time range.

anomalies*

object

end

date-time | null

ISO 8601 timestamp for when the anomaly ended, or null for a currently firing anomaly.

firingId

string

required

length ≥ 1

Identifies the alert firing for this anomaly.

start

date-time

required

ISO 8601 timestamp for when the anomaly started.

definitionId

string

required

length ≥ 1

Identifies the associated alert definition.

points

array of objects

required

length ≥ 1

Encapsulates the full range of graph data used to render traffic information.

points*

object

high

number

≥ 0

Upper bound of expected value. Only available for adaptive alerts.

low

number

≥ 0

Lower bound of expected value. Only available for adaptive alerts.

x

date-time

required

ISO 8601 timestamp for each data point.

y

number

required

≥ 0

For adaptive alerts, provides the observed value at that point. Otherwise yields 0 for static alerts, in which case x values simply define the overall range of the time series.

suppressions

array of objects

length ≥ 0

Suppressions associated with the alert.

suppressions

object

end

date-time

required

Defines the end of the suppressed time range.

start

date-time

required

Defines the start of the suppressed time range.

suppressionId

string

required

length ≥ 1

Identifies the suppressed time range.

200The response provides alert details.

400Bad request.

401Unauthorized error.

403Access is forbidden.

404Resource not found.

405Method not allowed.

500Server error.