Alerts (APIs)

Overview

When the performance or drift conditions defined for a policy are detected, the platform creates an alert with information about the related policy, detected conditions that triggered the alert, etc. Users assigned to alerts may receive notifications about alert conditions via email and Slack if configured as part of notifications.

Alert object

{
"policy_uuid": "123-abc-456",
"segment_id": 1,
"table_id": "1234",
"severity": 2,
"type": "drift",
"status": "Open",
"trigger_metric": "metric1",
"trigger_value": 0.25,
"data": {
 "key1": "value1"
 },
"assigned": null,
"uuid": "123-abc-456",
"created_ts": 1687885116458.172,
"modified_ts": 1687885116458.172,
"created_by": "user1",
"modified_by": "user2"
},
Property Type Description
policy_uuid string Unique ID of the policy associated with the alert. (Use to query the policy and access model associated with this alert.)
segment_id integer Unique ID of a segment associated with the alert, if any.
table_id string Foreign key reference to database row containing data containing the detected drift or model performance issue.
severity integer Severity of the alert, either 1 (warning level) or 2 (critical level).
type string Type of alert, either drift or model_performance.
status string Represents the status of the alert, either Open or Resolved.
trigger_metric string Metric that triggers the alert, such as PSI or mae.
trigger_value number Value of the metric that triggers the alert.
data array JSON body for the alert containing one or more key-value pairs. This contains the output of the policy run for analysis, such as baseline metrics, compared metrics, input baseline metrics, input target metrics, and more. The actual values vary depending on type of policy and trigger metric.
assigned string Name of platform user assigned to the alert.
uuid string Unique ID assigned to this alert.
created_ts Timestamp (Unix time in milliseconds) Timestamp when the alert was created.
modified_ts Timestamp (Unix time in milliseconds) Timestamp when the alert was last modified.
created_by string User who created the alert.
modified_by string User who last modified the alert.
TABLE OF CONTENTS