Simulate a monitor
curl --request POST \
--url https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate"
headers = {"X-API-KEY": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate', 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.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"monitor_id": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a",
"simulation_id": "sim_01J6C6J8VF7K8A4D7M2H5N9R3P",
"status": "PENDING",
"retention_warning": "Simulation results are retained for a limited time."
},
"metadata": {
"request_id": "req_01J6C6J96TVBKN6X3Z52JRDH8M",
"timestamp": "2026-08-28T08:12:15Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Monitors
Simulate a monitor
Test a monitor against recent historical data without activating it. The test runs in the background. Use the returned simulation_id to check its progress and results.
POST
/
v1
/
search-monitoring
/
monitors
/
{monitor_id}
/
simulate
Simulate a monitor
curl --request POST \
--url https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate"
headers = {"X-API-KEY": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate', 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.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"monitor_id": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a",
"simulation_id": "sim_01J6C6J8VF7K8A4D7M2H5N9R3P",
"status": "PENDING",
"retention_warning": "Simulation results are retained for a limited time."
},
"metadata": {
"request_id": "req_01J6C6J96TVBKN6X3Z52JRDH8M",
"timestamp": "2026-08-28T08:12:15Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API key created in the Bigdata Developer Platform.
Path Parameters
Unique identifier for the monitor.
Query Parameters
When the historical test should end, in UTC. This time must be at least five minutes in the past.
Number of consecutive periods to test. The length of each period matches the monitor's frequency, and the periods count backward from end_timestamp.
Required range:
x >= 1Was this page helpful?