Simulate a monitor

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))

}

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": "8c1f0a2e-6b4d-4f1a-9c3e-1a2b3c4d5e6f",
    "status": "PENDING",
    "phase": "accepted",
    "runs_requested": 3,
    "retention_warning": null
  },
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

{
  "errors": [
    {
      "message": "Monitor not found"
    }
  ],
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

{
  "errors": [
    {
      "message": "end_timestamp: must be at least 5 minutes in the past"
    }
  ],
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

{
  "errors": [
    {
      "message": "Internal server error"
    }
  ],
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

{
  "errors": [
    {
      "message": "Service unavailable"
    }
  ],
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

POST

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))

}

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": "8c1f0a2e-6b4d-4f1a-9c3e-1a2b3c4d5e6f",
    "status": "PENDING",
    "phase": "accepted",
    "runs_requested": 3,
    "retention_warning": null
  },
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

{
  "errors": [
    {
      "message": "Monitor not found"
    }
  ],
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

{
  "errors": [
    {
      "message": "end_timestamp: must be at least 5 minutes in the past"
    }
  ],
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

{
  "errors": [
    {
      "message": "Internal server error"
    }
  ],
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

{
  "errors": [
    {
      "message": "Service unavailable"
    }
  ],
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

Authorizations

X-API-KEY

string

header

required

API key from the Bigdata Developer Platform.

Path Parameters

monitor_id

string<uuid>

required

Id returned when you created the monitor.

Query Parameters

end_timestamp

string<date-time>

required

When the test should end. ISO 8601 with a timezone, at least five minutes ago.

start_timestamp

string<date-time>

When the test should start. ISO 8601 with a timezone, earlier than end_timestamp. Leave this out to test one run.

Response

The test was accepted and is running in the background. Read the results with List monitor runs.

data

object

required

Show child attributes

metadata

object

required

Show child attributes

API

Knowledge Graph

Search Service

Watchlists

Monitors

Research Service

Content

Structured Data

Subscription

SDK

Authorizations

Path Parameters

Query Parameters

Response