Alert Resource

The actual content of the alert depends on the request made and if the request timed out. The records and bucket fields are only present if timeout is false and depending on the options used in the request.

records and bucket are mutually exclusive no alert will contain both. In the event where both the anomaly score and normalized probability triggered, only the bucket will be set and it will contain all the anomaly records.

Important

Endpoint calls that timeout will have the timeout field set to true.

jobId:

The source of the alert

Type: String

timestamp:

The time the alert was generated in ISO 8601 format

Type: Date

alerttype:

The source of the alert either bucket, influcencer or bucketinfluencer. Default bucket.

Type: String

timeout:

True if the alert timed out. The longpoll call should be repeated.

Type: Boolean

isInterim:

True if the alert is triggered by an interim result. See Interim Results.

anomalyScore:

The anomaly score of the bucket that generated the alert.

Type: Number

maxNormalizedProbability:
 

The max normalized probabilty from the bucket that generated the alert.

Type: Number

bucket:

If the alert was triggered because the anomaly score threshold was reached then this is the result bucket otherwise it is not set.

Type: Bucket

records[]:

If the alert was triggered because the normalized probability threshold was reached then this is the list of anomaly records with normalized probability greater than or equal to the threshold.

Type: Array of Anomaly Records

uri:

Link the the API expanded bucket result

Type URI