Get Alert Definition

curl --request GET \
  --url https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}', 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.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": 123,
  "agent_id": 123,
  "name": "<string>",
  "severity": "<string>",
  "state": "<string>",
  "window_ms": 123,
  "cooldown_ms": 123,
  "recipients": [
    "<string>"
  ],
  "notification_channels": [
    "<string>"
  ],
  "condition_tree": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "threshold_type": "count",
  "threshold_n": 123,
  "threshold_percentage": 20,
  "threshold_minimum": 10,
  "last_triggered": "2026-07-31T14:05:12Z",
  "created_by": 123,
  "updated_by": 123
}

{
  "detail": "Not authenticated"
}

{
  "detail": "User does not have access to workspace 42"
}

{
  "detail": "Alert definition 4 not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

api

workspaces

{workspace_id}

agents

{agent_id}

settings

alert-definitions

{alert_id}

Get Alert Definition

curl --request GET \
  --url https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}', 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.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions/{alert_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": 123,
  "agent_id": 123,
  "name": "<string>",
  "severity": "<string>",
  "state": "<string>",
  "window_ms": 123,
  "cooldown_ms": 123,
  "recipients": [
    "<string>"
  ],
  "notification_channels": [
    "<string>"
  ],
  "condition_tree": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "threshold_type": "count",
  "threshold_n": 123,
  "threshold_percentage": 20,
  "threshold_minimum": 10,
  "last_triggered": "2026-07-31T14:05:12Z",
  "created_by": 123,
  "updated_by": 123
}

{
  "detail": "Not authenticated"
}

{
  "detail": "User does not have access to workspace 42"
}

{
  "detail": "Alert definition 4 not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

alert_id

integer

required

agent_id

integer

required

Tuner's internal numeric ID for the agent.

workspace_id

integer

required

Workspace ID. Find this in Workspace > General Settings.

Response

Successful Response

Response schema for an alert definition.

integer

required

Tuner's ID for this alert definition.

Example:

4

agent_id

integer

required

Agent this alert belongs to.

Example:

17

name

string

required

Display name, used in notifications.

Example:

"High red-flag rate"

severity

string

required

Severity label included in notifications.

Example:

"warning"

state

string

required

active when the alert can fire, paused when it can't.

Example:

"active"

window_ms

integer

required

Rolling window in milliseconds. 300000 is five minutes.

Example:

300000

cooldown_ms

integer

required

Minimum time in milliseconds before this alert can fire again.

Example:

900000

recipients

string[]

required

Email addresses notified when the alert fires.

Example:

["oncall@acme.com"]

notification_channels

string[]

required

Where notifications are sent.

Example:

["email"]

condition_tree

Condition Tree · object

required

Condition a call must match to count toward the threshold.

Example:

{
  "children": [
    {
      "lhs": "eval.12",
      "op": "eq",
      "rhs": "FAIL",
      "type": "predicate"
    }
  ],
  "op": "AND",
  "type": "group"
}

created_at

string<date-time>

required

When the alert was created.

Example:

"2026-07-14T09:22:31Z"

updated_at

string<date-time>

required

When the alert was last updated.

Example:

"2026-07-20T11:40:08Z"

description

string | null

Note explaining what this alert watches for.

threshold_type

string

default:count

count fires on an absolute number of matching calls, percentage on a share of the calls evaluated in the window.

Example:

"percentage"

threshold_n

integer | null

Matching calls needed to fire. Set in count mode.

threshold_percentage

number | null

Share of evaluated calls needed to fire. Set in percentage mode.

Example:

20

threshold_minimum

integer | null

Minimum matching calls before the percentage is applied. Set in percentage mode.

Example:

10

last_triggered

string<date-time> | null

When this alert last fired. Null if it never has.

Example:

"2026-07-31T14:05:12Z"

created_by

integer | null

User who created the alert.

updated_by

integer | null

User who last updated it.

⌘I