Alert Rules REST API Guide
List of all alert records during specified time_bucket_start and time_bucket_end for the given alert rule
List of all alert records during specified time_bucket_start and time_bucket_end for the given alert rule
alert id path parameter
requested start time
requested end time
Limit for the pagination
Offset for the pagination
Allows you to order results by any field. For desc order prefix field name with -
and provide comman separated values for multiple fields
Allows you to search by any field.
Name of the Feature
List of all alert records in the given time_bucket_start and time_bucket_end for the given alert rule
Bad Request
Internal Server Error
GET /v3/alert-rules/{alert_id}/records?start_time=2025-08-11T13%3A38%3A12.860Z&end_time=2025-08-11T13%3A38%3A12.860Z HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "PAGINATED",
"data": {
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"alert_rule_id": "123e4567-e89b-12d3-a456-426614174000",
"alert_rule_revision": 1,
"warning_threshold": 1,
"critical_threshold": 1,
"alert_run_start_time": 1,
"baseline_time_bucket": 1,
"baseline_value": 1,
"severity": "WARNING",
"alert_time_bucket": 1,
"alert_value": 1,
"failure_reason": "text",
"message": "text",
"feature_name": "text",
"alert_record_main_version": 1,
"alert_record_sub_version": 1,
"created_at": "2025-08-11T13:38:12.860Z",
"updated_at": "2025-08-11T13:38:12.860Z"
}
]
}
}
List latest alert record for each time bucket during specified time_bucket_start and time_bucket_end for the given alert rule
List latest alert record for each time bucket during specified time_bucket_start and time_bucket_end for the given alert rule
alert id path parameter
requested start time
requested end time
Name of the Feature
List of latest alert record for each time bucket during specified time_bucket_start and time_bucket_end for the given alert rule
Bad Request
Internal Server Error
GET /v3/alert-rules/{alert_id}/record-history?start_time=2025-08-11T13%3A38%3A12.860Z&end_time=2025-08-11T13%3A38%3A12.860Z HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"items": [
{
"time_bucket": 1,
"alert_count": 1,
"alert_history_count": 1,
"latest_record": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alert_rule_id": "123e4567-e89b-12d3-a456-426614174000",
"warning_threshold": 1,
"critical_threshold": 1,
"severity": "WARNING",
"alert_time_bucket": 1,
"alert_value": 1,
"feature_name": "text",
"created_at": "2025-08-11T13:38:12.860Z",
"updated_at": "2025-08-11T13:38:12.860Z"
}
}
]
}
}
List of all alert rule summary in the given time_bucket_start and time_bucket_end
Allows you to filter by any field.
Allows you to search by any field.
Allows you to order results by any field. For desc order prefix field name with -
and provide comman separated values for multiple fields
Limit for the pagination
Offset for the pagination
requested start time
requested end time
Summary of all alert rules in the given time_bucket_start and time_bucket_end
Bad Request
Internal Server Error
GET /v3/alert-rules/summary?start_time=2025-08-11T13%3A38%3A12.860Z&end_time=2025-08-11T13%3A38%3A12.860Z HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "PAGINATED",
"data": {
"items": [
{
"alert_rule_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"metric": {
"id": "text",
"display_name": "text",
"type": "drift",
"type_display_name": "Data Drift"
},
"is_fiddler_generated": true,
"priority": "HIGH",
"compare_to": "raw_value",
"bin_size": "Hour",
"condition": "text",
"alert_record_count": 1,
"alert_value": 1,
"feature_names": [
"text"
],
"threshold_type": "manual",
"critical_threshold": 1,
"warning_threshold": 1,
"enable_notification": true,
"compare_bin_delta": 1,
"latest_alert_record_value": 1,
"latest_alert_time_bucket": 1,
"latest_alert_feature_name": "text",
"latest_alert_feature_id": "text",
"latest_threshold": 1,
"latest_alert_record_severity": "WARNING",
"severity": "WARNING",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"baseline": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"segment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"definition": "text"
},
"created_at": "2025-08-11T13:38:12.860Z",
"updated_at": "2025-08-11T13:38:12.860Z",
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
]
}
}
Lists all alert rules configured for a model.
Limit for the pagination
Offset for the pagination
Allows you to filter by any field.
Allows you to order results by any field. For desc order prefix field name with -
and provide comman separated values for multiple fields
Allows you to search by any field.
Get list of Alert Rules in detail
Bad Request
Internal Server Error
GET /v3/alert-rules HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "PAGINATED",
"data": {
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"is_fiddler_generated": true,
"created_at": "2025-08-11T13:38:12.860Z",
"updated_at": "2025-08-11T13:38:12.860Z",
"name": "text",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"metric": {
"id": "text",
"display_name": "text",
"type": "drift",
"type_display_name": "Data Drift"
},
"feature_names": [
"text"
],
"priority": "HIGH",
"compare_to": "raw_value",
"condition": "lesser",
"compare_bin_delta": 1,
"evaluation_delay": 1,
"category": "text",
"bin_size": "Hour",
"threshold_type": "manual",
"auto_threshold_params": {
"warning_multiplier": 1,
"critical_multiplier": 1
},
"warning_threshold": 1,
"critical_threshold": 1,
"enable_notification": true,
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"baseline": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"segment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"definition": "text"
},
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
]
}
}
Creates Alert Rules
successful completion
Bad Request
Internal Server Error
Upstream connect error or disconnect/reset before headers
POST /v3/alert-rules HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 501
{
"compare_bin_delta": 1,
"evaluation_delay": 1,
"model_id": "123e4567-e89b-12d3-a456-426614174000",
"segment_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"metric_id": "text",
"feature_names": [
"text"
],
"category": "text",
"baseline_id": "123e4567-e89b-12d3-a456-426614174000",
"priority": "HIGH",
"bin_size": "Hour",
"compare_to": "raw_value",
"condition": "lesser",
"threshold_type": "manual",
"auto_threshold_params": {
"warning_multiplier": 1,
"critical_multiplier": 1
},
"warning_threshold": 1,
"critical_threshold": 1
}
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"is_fiddler_generated": true,
"created_at": "2025-08-11T13:38:12.860Z",
"updated_at": "2025-08-11T13:38:12.860Z",
"name": "text",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"metric": {
"id": "text",
"display_name": "text",
"type": "drift",
"type_display_name": "Data Drift"
},
"feature_names": [
"text"
],
"priority": "HIGH",
"compare_to": "raw_value",
"condition": "lesser",
"compare_bin_delta": 1,
"evaluation_delay": 1,
"category": "text",
"bin_size": "Hour",
"threshold_type": "manual",
"auto_threshold_params": {
"warning_multiplier": 1,
"critical_multiplier": 1
},
"warning_threshold": 1,
"critical_threshold": 1,
"enable_notification": true,
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"baseline": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"segment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"definition": "text"
},
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
}
Returns notification for the given Alert Rule id
alert id path parameter
Notification Details
Bad Request
Resource not found
Internal Server Error
GET /v3/alert-rules/{alert_id}/notification HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"emails": [
"text"
],
"pagerduty_services": [
"text"
],
"pagerduty_severity": "text",
"webhooks": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
}
Create Notification for an Alert Rule
alert id path parameter
successful completion
Bad Request
Resource not found
Internal Server Error
Upstream connect error or disconnect/reset before headers
POST /v3/alert-rules/{alert_id}/notification HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129
{
"emails": [
"text"
],
"pagerduty_services": [
"text"
],
"pagerduty_severity": "text",
"webhooks": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"emails": [
"text"
],
"pagerduty_services": [
"text"
],
"pagerduty_severity": "text",
"webhooks": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
}
Update Notification by Alert Rule id
alert id path parameter
Get detail info
Bad Request
Resource not found
Internal Server Error
Upstream connect error or disconnect/reset before headers
PATCH /v3/alert-rules/{alert_id}/notification HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129
{
"emails": [
"text"
],
"pagerduty_services": [
"text"
],
"pagerduty_severity": "text",
"webhooks": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"emails": [
"text"
],
"pagerduty_services": [
"text"
],
"pagerduty_severity": "text",
"webhooks": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
}
Returns Alert Rule for the given id
alert id path parameter
Alert Rule details
Bad Request
Resource not found
Internal Server Error
GET /v3/alert-rules/{alert_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"is_fiddler_generated": true,
"created_at": "2025-08-11T13:38:12.860Z",
"updated_at": "2025-08-11T13:38:12.860Z",
"name": "text",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"metric": {
"id": "text",
"display_name": "text",
"type": "drift",
"type_display_name": "Data Drift"
},
"feature_names": [
"text"
],
"priority": "HIGH",
"compare_to": "raw_value",
"condition": "lesser",
"compare_bin_delta": 1,
"evaluation_delay": 1,
"category": "text",
"bin_size": "Hour",
"threshold_type": "manual",
"auto_threshold_params": {
"warning_multiplier": 1,
"critical_multiplier": 1
},
"warning_threshold": 1,
"critical_threshold": 1,
"enable_notification": true,
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"baseline": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"segment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"definition": "text"
},
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
}
Deletes an Alert Rule
alert id path parameter
Success
Bad Request
Resource not found
Internal Server Error
DELETE /v3/alert-rules/{alert_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Update Alert Rule by id
alert id path parameter
Get detail info
Bad Request
Resource not found
Internal Server Error
PATCH /v3/alert-rules/{alert_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 199
{
"name": "text",
"warning_threshold": 1,
"critical_threshold": 1,
"evaluation_delay": 1,
"priority": "HIGH",
"enable_notification": true,
"auto_threshold_params": {
"warning_multiplier": 1,
"critical_multiplier": 1
}
}
{
"api_version": "3.0",
"kind": "NORMAL",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"is_fiddler_generated": true,
"created_at": "2025-08-11T13:38:12.860Z",
"updated_at": "2025-08-11T13:38:12.860Z",
"name": "text",
"organization": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"metric": {
"id": "text",
"display_name": "text",
"type": "drift",
"type_display_name": "Data Drift"
},
"feature_names": [
"text"
],
"priority": "HIGH",
"compare_to": "raw_value",
"condition": "lesser",
"compare_bin_delta": 1,
"evaluation_delay": 1,
"category": "text",
"bin_size": "Hour",
"threshold_type": "manual",
"auto_threshold_params": {
"warning_multiplier": 1,
"critical_multiplier": 1
},
"warning_threshold": 1,
"critical_threshold": 1,
"enable_notification": true,
"model": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"version": "text"
},
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"asset_type": "ML_MODEL"
},
"baseline": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"segment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"definition": "text"
},
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"updated_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
}
}
}
Last updated
Was this helpful?