List monitor runs
curl --request GET \
--url https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs', 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}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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}/runs"
req, _ := http.NewRequest("GET", 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.get("https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "run_01J6C72NV6A58H25PHX61DRE3G",
"status": "COMPLETED",
"is_simulation": true,
"simulation_id": "sim_01J6C6J8VF7K8A4D7M2H5N9R3P",
"window_start": "2026-08-27T08:00:00Z",
"window_end": "2026-08-27T12:00:00Z",
"event_count": 1,
"events": [
{
"id": "evt_01J6C75H9JH9R5Y40MP8S6DKN2",
"summary": "The central bank held its policy rate unchanged and signaled that future decisions will remain data-dependent.",
"central_bank": "Example Central Bank",
"decision": "hold",
"grounding": [
{
"id": "A97B4203751F",
"headline": "Central bank holds policy rate",
"source": {
"id": "5E6268",
"name": "Example Financial News"
},
"url": "https://example.com/central-bank-rate-decision",
"cnum": 2,
"timestamp": "2026-08-27T10:30:00Z"
}
]
}
],
"usage": {
"api_query_units": 1
}
}
],
"pagination": {
"has_cursor": false
},
"metadata": {
"request_id": "req_01J6C77FKQY3HMR9K3VX60B4Y4",
"timestamp": "2026-08-28T08:12:15Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Monitors
List monitor runs
View completed, pending, or failed runs for a monitor. Choose live or simulation runs. Set include_events=true to include the events found during each run.
GET
/
v1
/
search-monitoring
/
monitors
/
{monitor_id}
/
runs
List monitor runs
curl --request GET \
--url https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs', 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}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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}/runs"
req, _ := http.NewRequest("GET", 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.get("https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "run_01J6C72NV6A58H25PHX61DRE3G",
"status": "COMPLETED",
"is_simulation": true,
"simulation_id": "sim_01J6C6J8VF7K8A4D7M2H5N9R3P",
"window_start": "2026-08-27T08:00:00Z",
"window_end": "2026-08-27T12:00:00Z",
"event_count": 1,
"events": [
{
"id": "evt_01J6C75H9JH9R5Y40MP8S6DKN2",
"summary": "The central bank held its policy rate unchanged and signaled that future decisions will remain data-dependent.",
"central_bank": "Example Central Bank",
"decision": "hold",
"grounding": [
{
"id": "A97B4203751F",
"headline": "Central bank holds policy rate",
"source": {
"id": "5E6268",
"name": "Example Financial News"
},
"url": "https://example.com/central-bank-rate-decision",
"cnum": 2,
"timestamp": "2026-08-27T10:30:00Z"
}
]
}
],
"usage": {
"api_query_units": 1
}
}
],
"pagination": {
"has_cursor": false
},
"metadata": {
"request_id": "req_01J6C77FKQY3HMR9K3VX60B4Y4",
"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
Return runs from the active monitor (production) or a historical test (simulation).
Available options:
production, simulation Return runs from one historical test. Use with type=simulation.
Filter by run status.
PENDING is still processing, COMPLETED is ready to review, and FAILED could not be completed.
Available options:
PENDING, COMPLETED, FAILED Include the structured events found during each run.
Maximum number of live runs to return. This setting does not affect simulation runs.
Required range:
x >= 1Was this page helpful?