👨‍💻 API Reference 📣 Release Notes 📺 Request a Demo

Alert Rules REST API Guide

PreviousJobs REST API Guide NextEnvironments REST API Guide

Last updated 4 months ago

Was this helpful?

List of all alert records during specified time_bucket_start and time_bucket_end for the given alert rule

get

/v3/alert-rules/{alert_id}/records

Authorizations

Path parameters

alert_idstring · uuidrequired

alert id path parameter

Query parameters

start_timestring · date-timerequired

requested start time

end_timestring · date-timerequired

requested end time

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

orderingstring

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

searchstring

Allows you to search by any field.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/alert-rules/{alert_id}/records?start_time=2025-03-10T07%3A45%3A42.058Z&end_time=2025-03-10T07%3A45%3A42.058Z' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

500

{
  "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-03-10T07:45:42.058Z",
        "updated_at": "2025-03-10T07:45:42.058Z"
      }
    ]
  }
}

List of all alert records in the given 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

get

/v3/alert-rules/{alert_id}/record-history

Authorizations

Path parameters

alert_idstring · uuidrequired

alert id path parameter

Query parameters

start_timestring · date-timerequired

requested start time

end_timestring · date-timerequired

requested end time

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/alert-rules/{alert_id}/record-history?start_time=2025-03-10T07%3A45%3A42.058Z&end_time=2025-03-10T07%3A45%3A42.058Z' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

500

{
  "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",
          "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-03-10T07:45:42.058Z",
          "updated_at": "2025-03-10T07:45:42.058Z"
        }
      }
    ]
  }
}

List of latest alert record for each time bucket during specified time_bucket_start and time_bucket_end for the given alert rule

List of all alert rule summary in the given time_bucket_start and time_bucket_end

get

/v3/alert-rules/summary

Authorizations

Query parameters

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

start_timestring · date-timerequired

requested start time

end_timestring · date-timerequired

requested end time

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/alert-rules/summary?start_time=2025-03-10T07%3A45%3A42.058Z&end_time=2025-03-10T07%3A45%3A42.058Z' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

500

{
  "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_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"
        },
        "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-03-10T07:45:42.058Z",
        "updated_at": "2025-03-10T07:45:42.058Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        }
      }
    ]
  }
}

Summary of all alert rules in the given time_bucket_start and time_bucket_end

Lists all alert rules configured for a model.

get

/v3/alert-rules

Authorizations

Query parameters

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

filterstring

Allows you to filter by any field.

orderingstring

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

searchstring

Allows you to search by any field.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/alert-rules' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

500

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "is_fiddler_generated": true,
        "created_at": "2025-03-10T07:45:42.058Z",
        "updated_at": "2025-03-10T07:45:42.058Z",
        "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"
        },
        "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": "hello@example.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        }
      }
    ]
  }
}

Get list of Alert Rules in detail

Creates Alert Rules

post

/v3/alert-rules

Authorizations

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/alert-rules' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
  }'

200

400

500

503

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_fiddler_generated": true,
    "created_at": "2025-03-10T07:45:42.058Z",
    "updated_at": "2025-03-10T07:45:42.058Z",
    "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"
    },
    "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": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    }
  }
}

successful completion

Returns notification for the given Alert Rule id

get

/v3/alert-rules/{alert_id}/notification

Authorizations

Path parameters

alert_idstring · uuidrequired

alert id path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/alert-rules/{alert_id}/notification' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "emails": [
      "text"
    ],
    "pagerduty_services": [
      "text"
    ],
    "pagerduty_severity": "text",
    "webhooks": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

Notification Details

Create Notification for an Alert Rule

post

/v3/alert-rules/{alert_id}/notification

Authorizations

Path parameters

alert_idstring · uuidrequired

alert id path parameter

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/alert-rules/{alert_id}/notification' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "emails": [
      "text"
    ],
    "pagerduty_services": [
      "text"
    ],
    "pagerduty_severity": "text",
    "webhooks": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

400

404

500

503

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "emails": [
      "text"
    ],
    "pagerduty_services": [
      "text"
    ],
    "pagerduty_severity": "text",
    "webhooks": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

successful completion

Update by id

Update Notification by Alert Rule id

patch

/v3/alert-rules/{alert_id}/notification

Authorizations

Path parameters

alert_idstring · uuidrequired

alert id path parameter

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v3/alert-rules/{alert_id}/notification' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "emails": [
      "text"
    ],
    "pagerduty_services": [
      "text"
    ],
    "pagerduty_severity": "text",
    "webhooks": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

400

404

500

503

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "emails": [
      "text"
    ],
    "pagerduty_services": [
      "text"
    ],
    "pagerduty_severity": "text",
    "webhooks": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

Get detail info

Returns Alert Rule for the given id

get

/v3/alert-rules/{alert_id}

Authorizations

Path parameters

alert_idstring · uuidrequired

alert id path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/alert-rules/{alert_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_fiddler_generated": true,
    "created_at": "2025-03-10T07:45:42.058Z",
    "updated_at": "2025-03-10T07:45:42.058Z",
    "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"
    },
    "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": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    }
  }
}

Alert Rule details

Deletes an Alert Rule

delete

/v3/alert-rules/{alert_id}

Authorizations

Path parameters

alert_idstring · uuidrequired

alert id path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v3/alert-rules/{alert_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

500

No body

Success

Update by id

Update Alert Rule by id

patch

/v3/alert-rules/{alert_id}

Authorizations

Path parameters

alert_idstring · uuidrequired

alert id path parameter

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v3/alert-rules/{alert_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_fiddler_generated": true,
    "created_at": "2025-03-10T07:45:42.058Z",
    "updated_at": "2025-03-10T07:45:42.058Z",
    "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"
    },
    "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": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    }
  }
}

Get detail info

List of all alert records 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

List of all alert rule summary in the given time_bucket_start and time_bucket_end

Lists all alert rules configured for a model.

Creates Alert Rules

Show child attributes

Returns notification for the given Alert Rule id

Show child attributes

Update by id

Show child attributes

Returns Alert Rule for the given id

Deletes an Alert Rule

Update by id

Show child attributes