Evaluate an unsaved alert rule
curl --request POST \
--url https://app.aiaxoniq.com/api/alerts/preview \
--header 'Content-Type: application/json' \
--cookie oiq_token= \
--data '
{
"name": "<string>",
"description": "<string>",
"alertType": "<string>",
"targetSignal": "<string>",
"targetQuery": "<string>",
"condition": "<string>",
"threshold": 123,
"evaluationMins": 123,
"cooldownMins": 123,
"severity": "<string>",
"channel": "<string>",
"channelConfig": {},
"sloTarget": 123,
"burnRateWindow": 123,
"compositeRules": {},
"governanceConfig": {},
"runbookUrl": "<string>",
"enabled": true
}
'import requests
url = "https://app.aiaxoniq.com/api/alerts/preview"
payload = {
"name": "<string>",
"description": "<string>",
"alertType": "<string>",
"targetSignal": "<string>",
"targetQuery": "<string>",
"condition": "<string>",
"threshold": 123,
"evaluationMins": 123,
"cooldownMins": 123,
"severity": "<string>",
"channel": "<string>",
"channelConfig": {},
"sloTarget": 123,
"burnRateWindow": 123,
"compositeRules": {},
"governanceConfig": {},
"runbookUrl": "<string>",
"enabled": True
}
headers = {
"cookie": "oiq_token=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'oiq_token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
alertType: '<string>',
targetSignal: '<string>',
targetQuery: '<string>',
condition: '<string>',
threshold: 123,
evaluationMins: 123,
cooldownMins: 123,
severity: '<string>',
channel: '<string>',
channelConfig: {},
sloTarget: 123,
burnRateWindow: 123,
compositeRules: {},
governanceConfig: {},
runbookUrl: '<string>',
enabled: true
})
};
fetch('https://app.aiaxoniq.com/api/alerts/preview', 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://app.aiaxoniq.com/api/alerts/preview",
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([
'name' => '<string>',
'description' => '<string>',
'alertType' => '<string>',
'targetSignal' => '<string>',
'targetQuery' => '<string>',
'condition' => '<string>',
'threshold' => 123,
'evaluationMins' => 123,
'cooldownMins' => 123,
'severity' => '<string>',
'channel' => '<string>',
'channelConfig' => [
],
'sloTarget' => 123,
'burnRateWindow' => 123,
'compositeRules' => [
],
'governanceConfig' => [
],
'runbookUrl' => '<string>',
'enabled' => true
]),
CURLOPT_COOKIE => "oiq_token=",
CURLOPT_HTTPHEADER => [
"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://app.aiaxoniq.com/api/alerts/preview"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alertType\": \"<string>\",\n \"targetSignal\": \"<string>\",\n \"targetQuery\": \"<string>\",\n \"condition\": \"<string>\",\n \"threshold\": 123,\n \"evaluationMins\": 123,\n \"cooldownMins\": 123,\n \"severity\": \"<string>\",\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"sloTarget\": 123,\n \"burnRateWindow\": 123,\n \"compositeRules\": {},\n \"governanceConfig\": {},\n \"runbookUrl\": \"<string>\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "oiq_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://app.aiaxoniq.com/api/alerts/preview")
.header("cookie", "oiq_token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alertType\": \"<string>\",\n \"targetSignal\": \"<string>\",\n \"targetQuery\": \"<string>\",\n \"condition\": \"<string>\",\n \"threshold\": 123,\n \"evaluationMins\": 123,\n \"cooldownMins\": 123,\n \"severity\": \"<string>\",\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"sloTarget\": 123,\n \"burnRateWindow\": 123,\n \"compositeRules\": {},\n \"governanceConfig\": {},\n \"runbookUrl\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiaxoniq.com/api/alerts/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'oiq_token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alertType\": \"<string>\",\n \"targetSignal\": \"<string>\",\n \"targetQuery\": \"<string>\",\n \"condition\": \"<string>\",\n \"threshold\": 123,\n \"evaluationMins\": 123,\n \"cooldownMins\": 123,\n \"severity\": \"<string>\",\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"sloTarget\": 123,\n \"burnRateWindow\": 123,\n \"compositeRules\": {},\n \"governanceConfig\": {},\n \"runbookUrl\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_bodyAlerts
Evaluate an unsaved alert rule
Read-only: queries ClickHouse, writes nothing and notifies nobody. Takes the same draft rule shape as POST /api/alerts.
POST
/
api
/
alerts
/
preview
Evaluate an unsaved alert rule
curl --request POST \
--url https://app.aiaxoniq.com/api/alerts/preview \
--header 'Content-Type: application/json' \
--cookie oiq_token= \
--data '
{
"name": "<string>",
"description": "<string>",
"alertType": "<string>",
"targetSignal": "<string>",
"targetQuery": "<string>",
"condition": "<string>",
"threshold": 123,
"evaluationMins": 123,
"cooldownMins": 123,
"severity": "<string>",
"channel": "<string>",
"channelConfig": {},
"sloTarget": 123,
"burnRateWindow": 123,
"compositeRules": {},
"governanceConfig": {},
"runbookUrl": "<string>",
"enabled": true
}
'import requests
url = "https://app.aiaxoniq.com/api/alerts/preview"
payload = {
"name": "<string>",
"description": "<string>",
"alertType": "<string>",
"targetSignal": "<string>",
"targetQuery": "<string>",
"condition": "<string>",
"threshold": 123,
"evaluationMins": 123,
"cooldownMins": 123,
"severity": "<string>",
"channel": "<string>",
"channelConfig": {},
"sloTarget": 123,
"burnRateWindow": 123,
"compositeRules": {},
"governanceConfig": {},
"runbookUrl": "<string>",
"enabled": True
}
headers = {
"cookie": "oiq_token=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'oiq_token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
alertType: '<string>',
targetSignal: '<string>',
targetQuery: '<string>',
condition: '<string>',
threshold: 123,
evaluationMins: 123,
cooldownMins: 123,
severity: '<string>',
channel: '<string>',
channelConfig: {},
sloTarget: 123,
burnRateWindow: 123,
compositeRules: {},
governanceConfig: {},
runbookUrl: '<string>',
enabled: true
})
};
fetch('https://app.aiaxoniq.com/api/alerts/preview', 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://app.aiaxoniq.com/api/alerts/preview",
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([
'name' => '<string>',
'description' => '<string>',
'alertType' => '<string>',
'targetSignal' => '<string>',
'targetQuery' => '<string>',
'condition' => '<string>',
'threshold' => 123,
'evaluationMins' => 123,
'cooldownMins' => 123,
'severity' => '<string>',
'channel' => '<string>',
'channelConfig' => [
],
'sloTarget' => 123,
'burnRateWindow' => 123,
'compositeRules' => [
],
'governanceConfig' => [
],
'runbookUrl' => '<string>',
'enabled' => true
]),
CURLOPT_COOKIE => "oiq_token=",
CURLOPT_HTTPHEADER => [
"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://app.aiaxoniq.com/api/alerts/preview"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alertType\": \"<string>\",\n \"targetSignal\": \"<string>\",\n \"targetQuery\": \"<string>\",\n \"condition\": \"<string>\",\n \"threshold\": 123,\n \"evaluationMins\": 123,\n \"cooldownMins\": 123,\n \"severity\": \"<string>\",\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"sloTarget\": 123,\n \"burnRateWindow\": 123,\n \"compositeRules\": {},\n \"governanceConfig\": {},\n \"runbookUrl\": \"<string>\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "oiq_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://app.aiaxoniq.com/api/alerts/preview")
.header("cookie", "oiq_token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alertType\": \"<string>\",\n \"targetSignal\": \"<string>\",\n \"targetQuery\": \"<string>\",\n \"condition\": \"<string>\",\n \"threshold\": 123,\n \"evaluationMins\": 123,\n \"cooldownMins\": 123,\n \"severity\": \"<string>\",\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"sloTarget\": 123,\n \"burnRateWindow\": 123,\n \"compositeRules\": {},\n \"governanceConfig\": {},\n \"runbookUrl\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiaxoniq.com/api/alerts/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'oiq_token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alertType\": \"<string>\",\n \"targetSignal\": \"<string>\",\n \"targetQuery\": \"<string>\",\n \"condition\": \"<string>\",\n \"threshold\": 123,\n \"evaluationMins\": 123,\n \"cooldownMins\": 123,\n \"severity\": \"<string>\",\n \"channel\": \"<string>\",\n \"channelConfig\": {},\n \"sloTarget\": 123,\n \"burnRateWindow\": 123,\n \"compositeRules\": {},\n \"governanceConfig\": {},\n \"runbookUrl\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
sessionCookiebearerAuth
Query Parameters
Tenant identifier. Overwritten from the authenticated session; a value naming a different tenant is refused with 403.
Required string length:
1 - 64Pattern:
^[A-Za-z0-9][A-Za-z0-9_-]*$Body
application/json
Required string length:
1 - 256Maximum string length:
4096Maximum string length:
32Maximum string length:
64Maximum string length:
8192Maximum string length:
16Maximum string length:
16Maximum string length:
32Maximum string length:
2048Response
200
Success
⌘I