Creates Alert Rules

curl --request POST \
  --url https://api.example.com/v3/alert-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "metric_id": "<string>",
  "compare_bin_delta": 123,
  "evaluation_delay": 123,
  "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "feature_names": [
    "<string>"
  ],
  "category": "<string>",
  "baseline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auto_threshold_params": {
    "warning_multiplier": 123,
    "critical_multiplier": 123
  },
  "warning_threshold": 123,
  "critical_threshold": 123
}
'

import requests

url = "https://api.example.com/v3/alert-rules"

payload = {
    "model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "metric_id": "<string>",
    "compare_bin_delta": 123,
    "evaluation_delay": 123,
    "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "feature_names": ["<string>"],
    "category": "<string>",
    "baseline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "auto_threshold_params": {
        "warning_multiplier": 123,
        "critical_multiplier": 123
    },
    "warning_threshold": 123,
    "critical_threshold": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    metric_id: '<string>',
    compare_bin_delta: 123,
    evaluation_delay: 123,
    segment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    feature_names: ['<string>'],
    category: '<string>',
    baseline_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    auto_threshold_params: {warning_multiplier: 123, critical_multiplier: 123},
    warning_threshold: 123,
    critical_threshold: 123
  })
};

fetch('https://api.example.com/v3/alert-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/alert-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'metric_id' => '<string>',
    'compare_bin_delta' => 123,
    'evaluation_delay' => 123,
    'segment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'feature_names' => [
        '<string>'
    ],
    'category' => '<string>',
    'baseline_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'auto_threshold_params' => [
        'warning_multiplier' => 123,
        'critical_multiplier' => 123
    ],
    'warning_threshold' => 123,
    'critical_threshold' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/alert-rules"

	payload := strings.NewReader("{\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"metric_id\": \"<string>\",\n  \"compare_bin_delta\": 123,\n  \"evaluation_delay\": 123,\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feature_names\": [\n    \"<string>\"\n  ],\n  \"category\": \"<string>\",\n  \"baseline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"auto_threshold_params\": {\n    \"warning_multiplier\": 123,\n    \"critical_multiplier\": 123\n  },\n  \"warning_threshold\": 123,\n  \"critical_threshold\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v3/alert-rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"metric_id\": \"<string>\",\n  \"compare_bin_delta\": 123,\n  \"evaluation_delay\": 123,\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feature_names\": [\n    \"<string>\"\n  ],\n  \"category\": \"<string>\",\n  \"baseline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"auto_threshold_params\": {\n    \"warning_multiplier\": 123,\n    \"critical_multiplier\": 123\n  },\n  \"warning_threshold\": 123,\n  \"critical_threshold\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/alert-rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"metric_id\": \"<string>\",\n  \"compare_bin_delta\": 123,\n  \"evaluation_delay\": 123,\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feature_names\": [\n    \"<string>\"\n  ],\n  \"category\": \"<string>\",\n  \"baseline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"auto_threshold_params\": {\n    \"warning_multiplier\": 123,\n    \"critical_multiplier\": 123\n  },\n  \"warning_threshold\": 123,\n  \"critical_threshold\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "organization": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "metric": {
      "id": "<string>",
      "display_name": "<string>"
    },
    "evaluation_delay": 123,
    "model": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "version": "<string>"
    },
    "project": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "baseline": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "full_name": "<string>"
    },
    "updated_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "full_name": "<string>"
    },
    "is_fiddler_generated": true,
    "feature_names": [
      "<string>"
    ],
    "compare_bin_delta": 123,
    "category": "<string>",
    "auto_threshold_params": {
      "warning_multiplier": 123,
      "critical_multiplier": 123
    },
    "warning_threshold": 123,
    "critical_threshold": 123,
    "enable_notification": true,
    "segment": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definition": "<string>"
    }
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

POST

alert-rules

Creates Alert Rules

curl --request POST \
  --url https://api.example.com/v3/alert-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "metric_id": "<string>",
  "compare_bin_delta": 123,
  "evaluation_delay": 123,
  "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "feature_names": [
    "<string>"
  ],
  "category": "<string>",
  "baseline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auto_threshold_params": {
    "warning_multiplier": 123,
    "critical_multiplier": 123
  },
  "warning_threshold": 123,
  "critical_threshold": 123
}
'

import requests

url = "https://api.example.com/v3/alert-rules"

payload = {
    "model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "metric_id": "<string>",
    "compare_bin_delta": 123,
    "evaluation_delay": 123,
    "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "feature_names": ["<string>"],
    "category": "<string>",
    "baseline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "auto_threshold_params": {
        "warning_multiplier": 123,
        "critical_multiplier": 123
    },
    "warning_threshold": 123,
    "critical_threshold": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    metric_id: '<string>',
    compare_bin_delta: 123,
    evaluation_delay: 123,
    segment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    feature_names: ['<string>'],
    category: '<string>',
    baseline_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    auto_threshold_params: {warning_multiplier: 123, critical_multiplier: 123},
    warning_threshold: 123,
    critical_threshold: 123
  })
};

fetch('https://api.example.com/v3/alert-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/alert-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'metric_id' => '<string>',
    'compare_bin_delta' => 123,
    'evaluation_delay' => 123,
    'segment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'feature_names' => [
        '<string>'
    ],
    'category' => '<string>',
    'baseline_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'auto_threshold_params' => [
        'warning_multiplier' => 123,
        'critical_multiplier' => 123
    ],
    'warning_threshold' => 123,
    'critical_threshold' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/alert-rules"

	payload := strings.NewReader("{\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"metric_id\": \"<string>\",\n  \"compare_bin_delta\": 123,\n  \"evaluation_delay\": 123,\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feature_names\": [\n    \"<string>\"\n  ],\n  \"category\": \"<string>\",\n  \"baseline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"auto_threshold_params\": {\n    \"warning_multiplier\": 123,\n    \"critical_multiplier\": 123\n  },\n  \"warning_threshold\": 123,\n  \"critical_threshold\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v3/alert-rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"metric_id\": \"<string>\",\n  \"compare_bin_delta\": 123,\n  \"evaluation_delay\": 123,\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feature_names\": [\n    \"<string>\"\n  ],\n  \"category\": \"<string>\",\n  \"baseline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"auto_threshold_params\": {\n    \"warning_multiplier\": 123,\n    \"critical_multiplier\": 123\n  },\n  \"warning_threshold\": 123,\n  \"critical_threshold\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/alert-rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"metric_id\": \"<string>\",\n  \"compare_bin_delta\": 123,\n  \"evaluation_delay\": 123,\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feature_names\": [\n    \"<string>\"\n  ],\n  \"category\": \"<string>\",\n  \"baseline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"auto_threshold_params\": {\n    \"warning_multiplier\": 123,\n    \"critical_multiplier\": 123\n  },\n  \"warning_threshold\": 123,\n  \"critical_threshold\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "organization": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "metric": {
      "id": "<string>",
      "display_name": "<string>"
    },
    "evaluation_delay": 123,
    "model": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "version": "<string>"
    },
    "project": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "baseline": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "full_name": "<string>"
    },
    "updated_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "full_name": "<string>"
    },
    "is_fiddler_generated": true,
    "feature_names": [
      "<string>"
    ],
    "compare_bin_delta": 123,
    "category": "<string>",
    "auto_threshold_params": {
      "warning_multiplier": 123,
      "critical_multiplier": 123
    },
    "warning_threshold": 123,
    "critical_threshold": 123,
    "enable_notification": true,
    "segment": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definition": "<string>"
    }
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

model_id

string<uuid>

required

Unique identifier of the model.

name

string

required

Name of the Alert Rule.

metric_id

string

required

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

priority

enum<string>

required

Available options:

HIGH,

MEDIUM,

LOW

bin_size

enum<string>

required

The Supported bin sizes for the Alert Rules.

Available options:

Hour,

Day,

Week,

Month

compare_to

enum<string>

required

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.

Available options:

raw_value,

time_period

condition

enum<string>

required

The comparison condition while evaluating the Alert Rule.

Available options:

lesser,

greater

threshold_type

enum<string>

required

The type of threshold algorithm used to evaluate alerts.

Available options:

manual,

standard_deviation_auto_threshold

compare_bin_delta

integer

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_delay

integer

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

segment_id

string<uuid>

Unique identifier of the segment.

feature_names

string[]

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

Response

successful completion

Response object for standard API responses.

api_version

enum<string>

default:3.0

API version.

Available options:

2.0,

3.0

kind

enum<string>

default:NORMAL

Type of response, indicating a normal response.

Available options:

NORMAL

data

object

Show child attributes

createNotificationForAlertRule

Deletes an Alert Rule

⌘I

Fiddler Python Client SDK

Fiddler Evals SDK

Fiddler OTel SDK

Fiddler LangGraph SDK

Fiddler LangChain SDK

Fiddler Google ADK SDK

Fiddler Strands Agent SDK

Fiddler OTel JS SDK

Fiddler LangGraph JS SDK

Fiddler LangChain JS SDK

Creates Alert Rules

Authorizations

Body

Response