Preview a monitor query against historical data
curl --request POST \
--url https://api.dev.swarmd.ai/audit/v1/monitors/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queryConfig": {
"type": "<string>",
"filters": [
{
"values": [
"<string>"
]
}
],
"warningPercentChange": 123,
"criticalPercentChange": 123
},
"lookbackDays": 123
}
'import requests
url = "https://api.dev.swarmd.ai/audit/v1/monitors/preview"
payload = {
"queryConfig": {
"type": "<string>",
"filters": [{ "values": ["<string>"] }],
"warningPercentChange": 123,
"criticalPercentChange": 123
},
"lookbackDays": 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({
queryConfig: {
type: '<string>',
filters: [{values: ['<string>']}],
warningPercentChange: 123,
criticalPercentChange: 123
},
lookbackDays: 123
})
};
fetch('https://api.dev.swarmd.ai/audit/v1/monitors/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://api.dev.swarmd.ai/audit/v1/monitors/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([
'queryConfig' => [
'type' => '<string>',
'filters' => [
[
'values' => [
'<string>'
]
]
],
'warningPercentChange' => 123,
'criticalPercentChange' => 123
],
'lookbackDays' => 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.dev.swarmd.ai/audit/v1/monitors/preview"
payload := strings.NewReader("{\n \"queryConfig\": {\n \"type\": \"<string>\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"warningPercentChange\": 123,\n \"criticalPercentChange\": 123\n },\n \"lookbackDays\": 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.dev.swarmd.ai/audit/v1/monitors/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"queryConfig\": {\n \"type\": \"<string>\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"warningPercentChange\": 123,\n \"criticalPercentChange\": 123\n },\n \"lookbackDays\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.swarmd.ai/audit/v1/monitors/preview")
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 \"queryConfig\": {\n \"type\": \"<string>\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"warningPercentChange\": 123,\n \"criticalPercentChange\": 123\n },\n \"lookbackDays\": 123\n}"
response = http.request(request)
puts response.read_body{
"simulatedAlertCount": 123,
"alerts": [
{
"when": "2023-11-07T05:31:56Z",
"severity": "LOW",
"subjectLabel": "<string>",
"value": 123
}
],
"warningHits": 123,
"criticalHits": 123,
"lookbackDays": 123,
"windowsEvaluated": 123
}Audit Monitors
Preview a monitor query against historical data
Security Requirements
| Auth Types | Entities | Permissions | Required Roles |
|---|---|---|---|
| USER | AUDIT | READ | AUDIT:READ |
POST
/
audit
/
v1
/
monitors
/
preview
Preview a monitor query against historical data
curl --request POST \
--url https://api.dev.swarmd.ai/audit/v1/monitors/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queryConfig": {
"type": "<string>",
"filters": [
{
"values": [
"<string>"
]
}
],
"warningPercentChange": 123,
"criticalPercentChange": 123
},
"lookbackDays": 123
}
'import requests
url = "https://api.dev.swarmd.ai/audit/v1/monitors/preview"
payload = {
"queryConfig": {
"type": "<string>",
"filters": [{ "values": ["<string>"] }],
"warningPercentChange": 123,
"criticalPercentChange": 123
},
"lookbackDays": 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({
queryConfig: {
type: '<string>',
filters: [{values: ['<string>']}],
warningPercentChange: 123,
criticalPercentChange: 123
},
lookbackDays: 123
})
};
fetch('https://api.dev.swarmd.ai/audit/v1/monitors/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://api.dev.swarmd.ai/audit/v1/monitors/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([
'queryConfig' => [
'type' => '<string>',
'filters' => [
[
'values' => [
'<string>'
]
]
],
'warningPercentChange' => 123,
'criticalPercentChange' => 123
],
'lookbackDays' => 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.dev.swarmd.ai/audit/v1/monitors/preview"
payload := strings.NewReader("{\n \"queryConfig\": {\n \"type\": \"<string>\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"warningPercentChange\": 123,\n \"criticalPercentChange\": 123\n },\n \"lookbackDays\": 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.dev.swarmd.ai/audit/v1/monitors/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"queryConfig\": {\n \"type\": \"<string>\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"warningPercentChange\": 123,\n \"criticalPercentChange\": 123\n },\n \"lookbackDays\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.swarmd.ai/audit/v1/monitors/preview")
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 \"queryConfig\": {\n \"type\": \"<string>\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"warningPercentChange\": 123,\n \"criticalPercentChange\": 123\n },\n \"lookbackDays\": 123\n}"
response = http.request(request)
puts response.read_body{
"simulatedAlertCount": 123,
"alerts": [
{
"when": "2023-11-07T05:31:56Z",
"severity": "LOW",
"subjectLabel": "<string>",
"value": 123
}
],
"warningHits": 123,
"criticalHits": 123,
"lookbackDays": 123,
"windowsEvaluated": 123
}Authorizations
JWT token (USER, AGENT, or SERVICE auth)
Body
application/json
