Alert Rules

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

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

Path parameters

alert_id*string (uuid)

alert id path parameter

Query parameters

Response

200400500

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

Body

application/json

api_versionenum

API version of the response.

2.03.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/{alert_id}/records?start_time=2025-01-22T07%3A05%3A13.568Z&end_time=2025-01-22T07%3A05%3A13.568Z', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "api_version": "2.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alert_rule_id": "123e4567-e89b-12d3-a456-426614174000",
        "alert_rule_revision": 0,
        "warning_threshold": 0,
        "critical_threshold": 0,
        "alert_run_start_time": 0,
        "baseline_time_bucket": 0,
        "baseline_value": 0,
        "severity": "WARNING",
        "alert_time_bucket": 0,
        "alert_value": 0,
        "failure_reason": "text",
        "message": "text",
        "feature_name": "text",
        "alert_record_main_version": 0,
        "alert_record_sub_version": 0,
        "created_at": "2025-01-22T07:05:13.568Z",
        "updated_at": "2025-01-22T07:05:13.568Z"
      }
    ]
  }
}

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

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

Path parameters

alert_id*string (uuid)

alert id path parameter

Query parameters

Response

200400500

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

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/{alert_id}/record-history?start_time=2025-01-22T07%3A05%3A13.568Z&end_time=2025-01-22T07%3A05%3A13.568Z', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "items": [
      {
        "time_bucket": 0,
        "alert_count": 0,
        "alert_history_count": 0,
        "latest_record": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "alert_rule_id": "123e4567-e89b-12d3-a456-426614174000",
          "alert_rule_revision": 0,
          "warning_threshold": 0,
          "critical_threshold": 0,
          "alert_run_start_time": 0,
          "baseline_time_bucket": 0,
          "baseline_value": 0,
          "severity": "WARNING",
          "alert_time_bucket": 0,
          "alert_value": 0,
          "failure_reason": "text",
          "message": "text",
          "feature_name": "text",
          "alert_record_main_version": 0,
          "alert_record_sub_version": 0,
          "created_at": "2025-01-22T07:05:13.568Z",
          "updated_at": "2025-01-22T07:05:13.568Z"
        }
      }
    ]
  }
}

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

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

GET/v3/alert-rules/summary

Query parameters

Response

200400500

Summary of all alert rules in the given time_bucket_start and time_bucket_end

Body

application/json

api_versionenum

API version of the response.

2.03.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/summary?start_time=2025-01-22T07%3A05%3A13.568Z&end_time=2025-01-22T07%3A05%3A13.568Z', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "api_version": "2.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"
        },
        "priority": "HIGH",
        "compare_to": "raw_value",
        "bin_size": "Hour",
        "condition": "text",
        "alert_record_count": 0,
        "alert_value": 0,
        "feature_names": [
          "text"
        ],
        "critical_threshold": 0,
        "warning_threshold": 0,
        "enable_notification": false,
        "version": "text",
        "compare_bin_delta": 0,
        "latest_alert_record_value": 0,
        "latest_alert_time_bucket": 0,
        "latest_alert_feature_name": "text",
        "latest_threshold": 0,
        "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-01-22T07:05:13.568Z",
        "updated_at": "2025-01-22T07:05:13.568Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        }
      }
    ]
  }
}

Lists all alert rules configured for a model.

Lists all alert rules configured for a model.

GET/v3/alert-rules

Query parameters

Response

200400500

Get list of Alert Rules in detail

Body

application/json

api_versionenum

API version of the response.

2.03.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "api_version": "2.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "created_at": "2025-01-22T07:05:13.568Z",
        "updated_at": "2025-01-22T07:05:13.568Z",
        "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",
        "version": "text",
        "compare_to": "raw_value",
        "condition": "lesser",
        "compare_bin_delta": 0,
        "evaluation_delay": 0,
        "category": "text",
        "bin_size": "Hour",
        "warning_threshold": 0,
        "critical_threshold": 0,
        "enable_notification": false,
        "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": "[e-mail]"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        }
      }
    ]
  }
}

Creates Alert Rules

Creates Alert Rules

POST/v3/alert-rules

Body

application/json

compare_bin_deltainteger

This field specifies the lookback period for relative comparisons, expressed as a multiple of the chosen time bin size. It determines the historical data timeframe used to evaluate changes in the metric value.

evaluation_delayinteger

It indroduces the delay in the evaluation of Alert Rule. It is in multiple of hours, and max could be one year.

model_id*string (uuid)

Unique identifier of the model.

segment_idstring (uuid)

Unique identifier of the segment.

name*string

Name of the Alert Rule.

metric_id*string

The unique identifier of the metric for which we want to create an Alert Rule.

feature_namesarray of string

List of feature names for which we want to create an Alert Rule.

categorystring

Setting Frequency Alerts on categorical columns requires specifying a category. For example, if the column represents geographical locations such as France, Germany, and India, you would pass 'France' as the category and 'geography' as the feature name to set a frequency alert.

baseline_idstring (uuid)

It should only be specified for the drift Alert Rules. Is is unique identifier of the baseline selected for drift calculations.

priority*PriorityEnum (enum)

HIGHMEDIUMLOW

bin_size*BinSizeEnum (enum)

The Supported bin sizes for the Alert Rules.

HourDayWeekMonth

compare_to*CompareToEnum (enum)

This API provides two alert evaluation methods, absolute comparisons determine if the current metric value breaches a predefined threshold, while relative comparisons analyze changes in metric by referencing a chosen time period.

raw_valuetime_period

condition*ConditionEnum (enum)

The comparison condition while evaluating the Alert Rule.

lessergreater

warning_thresholdnumber (double)

Threshold value for triggering a warning alert.

critical_threshold*number (double)

Threshold value for triggering a critical alert.

Response

200400500503

successful completion

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataAlertRule (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "model_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "priority": "HIGH",
      "metric_id": "text",
      "bin_size": "Hour",
      "compare_to": "raw_value",
      "condition": "lesser",
      "critical_threshold": 0
    }),
});
const data = await response.json();

Response

200400500503

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-01-22T07:05:13.568Z",
    "updated_at": "2025-01-22T07:05:13.568Z",
    "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",
    "version": "text",
    "compare_to": "raw_value",
    "condition": "lesser",
    "compare_bin_delta": 0,
    "evaluation_delay": 0,
    "category": "text",
    "bin_size": "Hour",
    "warning_threshold": 0,
    "critical_threshold": 0,
    "enable_notification": false,
    "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": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    }
  }
}

Returns notification for the given Alert Rule id

Returns notification for the given Alert Rule id

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

Path parameters

alert_id*string (uuid)

alert id path parameter

Response

200400404500

Notification Details

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataNotification (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/{alert_id}/notification', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

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

Create Notification for an Alert Rule

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

Path parameters

alert_id*string (uuid)

alert id path parameter

Body

application/json

emailsarray of string

pagerduty_servicesarray of string

pagerduty_severitystring

webhooksarray of string (uuid)

Response

200400404500503

successful completion

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataNotification (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/{alert_id}/notification', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500503

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

Update by id

Update Notification by Alert Rule id

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

Path parameters

alert_id*string (uuid)

alert id path parameter

Body

application/json

emailsarray of string

pagerduty_servicesarray of string

pagerduty_severitystring

webhooksarray of string (uuid)

Response

200400404500503

Get detail info

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataall of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/{alert_id}/notification', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500503

{
  "api_version": "2.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

Returns Alert Rule for the given id

GET/v3/alert-rules/{alert_id}

Path parameters

alert_id*string (uuid)

alert id path parameter

Response

200400404500

Alert Rule details

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataAlertRule (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/{alert_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-01-22T07:05:13.568Z",
    "updated_at": "2025-01-22T07:05:13.568Z",
    "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",
    "version": "text",
    "compare_to": "raw_value",
    "condition": "lesser",
    "compare_bin_delta": 0,
    "evaluation_delay": 0,
    "category": "text",
    "bin_size": "Hour",
    "warning_threshold": 0,
    "critical_threshold": 0,
    "enable_notification": false,
    "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": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    }
  }
}

Deletes an Alert Rule

Deletes an Alert Rule

DELETE/v3/alert-rules/{alert_id}

Path parameters

alert_id*string (uuid)

alert id path parameter

Response

200400404500

Success

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/{alert_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404500

{
  "api_version": "2.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "text"
      }
    ]
  }
}

Update by id

Update Alert Rule by id

PATCH/v3/alert-rules/{alert_id}

Path parameters

alert_id*string (uuid)

alert id path parameter

Body

application/json

namestring

Name of the Alert Rule.

warning_thresholdnullable number (float)

Warning threshold for the Alert Rule.

critical_thresholdnumber (float)

Critical threshold for the Alert Rule.

evaluation_delaynumber (integer)

Evaluation Delay for the Alert Rule. It is in number of hours.

priorityPriorityEnum (enum)

HIGHMEDIUMLOW

enable_notificationboolean

Indicates whether notifications are enabled for the Alert Rule.

Response

200400404500

Get detail info

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataall of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/alert-rules/{alert_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-01-22T07:05:13.568Z",
    "updated_at": "2025-01-22T07:05:13.568Z",
    "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",
    "version": "text",
    "compare_to": "raw_value",
    "condition": "lesser",
    "compare_bin_delta": 0,
    "evaluation_delay": 0,
    "category": "text",
    "bin_size": "Hour",
    "warning_threshold": 0,
    "critical_threshold": 0,
    "enable_notification": false,
    "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": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    }
  }
}