Manage Alerts

Tenant Id can be retrieved from the UI as listed here

List all open alerts for this tenant

GET https://demo.backend.telm.ai/{tenant}/configuration/alerts

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id

Query Parameters

Name	Type	Description
job_id	String	Job id to view alerts for

Headers

Name	Type	Description
Authorization*	String	Bearer {token}

200: OK List of Alerts

[
  {
    "attribute": "string",
    "create_time": "string",
    "data_drift": {
      "feature_core_name": "string",
      "metric_name": "string",
      "name": "string",
      "value": 0
    },
    "is_notification_enabled": true,
    "is_notified": true,
    "job_id": "string",
    "metric_time": "string",
    "metric_value": 0,
    "notification_channel_name": "string",
    "policy_name": "string",
    "source": "string",
    "type": "<alert type>",
    "violated_policy": {
      "attributes": [
        "string"
      ],
      "channel_name": "string",
      "condition": "string",
      "description": "string",
      "metric_type": "condition",
      "name": "string",
      "send_notifications": true,
      "threshold": 0
    },
    "violation_data": {},
    "violation_name": "string"
  }
]

Close an alert

PUT https://demo.backend.telm.ai/{tenant}/configuration/alerts

Path Parameters

Name	Type	Description
tenant*	String	Tenant Id

Headers

Name	Type	Description
Authorization*	String	Bearer {token}

Request Body

Name	Type	Description
attribute*	String	Name of attribute
job_id*	String	Job Id
violation_name*	String	Violation name

200: OK Alerts

[
  {
    "attribute": "string",
    "create_time": "string",
    "data_drift": {
      "feature_core_name": "string",
      "metric_name": "string",
      "name": "string",
      "value": 0
    },
    "is_notification_enabled": true,
    "is_notified": true,
    "job_id": "string",
    "metric_time": "string",
    "metric_value": 0,
    "notification_channel_name": "string",
    "policy_name": "string",
    "source": "string",
    "type": "<alert type>",
    "violated_policy": {
      "attributes": [
        "string"
      ],
      "channel_name": "string",
      "condition": "string",
      "description": "string",
      "metric_type": "condition",
      "name": "string",
      "send_notifications": true,
      "threshold": 0
    },
    "violation_data": {},
    "violation_name": "string"
  }
]