Get run details
curl --request GET \
--url https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs/{run_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs/{run_id}"
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/{run_id}', 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/{run_id}",
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/{run_id}"
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/{run_id}")
.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/{run_id}")
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{
"data": {
"id": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a",
"status": "COMPLETED",
"is_simulation": false,
"simulation_id": null,
"window_start": "2026-10-23T08:00:00Z",
"window_end": "2026-10-23T09:00:00Z",
"event_count": 1,
"events": [
{
"id": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a:0",
"summary": "BlackRock CFO resigned.",
"novel": true,
"company": {
"name": "BlackRock",
"rp_entity_id": "HJ95FV"
},
"departure_type": "resignation",
"grounding": [
{
"id": "A97B4203751F",
"headline": "BlackRock CFO steps down",
"source": {
"id": "5E6268",
"name": "Reuters"
},
"url": "https://example.com/blackrock-cfo-steps-down",
"cnum": 0,
"timestamp": "2026-10-23T08:12:00Z"
}
]
}
],
"usage": {
"premium_news_tokens": 1200,
"model_tokens": 800
}
},
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Run not found"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Response too large"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "schedule.frequency: value is not a valid frequency"
}
],
"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"
}
}Runs
Get run details
One run, including its events.
A live run includes only new events. A test also includes events that were not new, so you can see everything the monitor extracted.
GET
/
v1
/
search-monitoring
/
monitors
/
{monitor_id}
/
runs
/
{run_id}
Get run details
curl --request GET \
--url https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs/{run_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs/{run_id}"
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/{run_id}', 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/{run_id}",
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/{run_id}"
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/{run_id}")
.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/{run_id}")
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{
"data": {
"id": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a",
"status": "COMPLETED",
"is_simulation": false,
"simulation_id": null,
"window_start": "2026-10-23T08:00:00Z",
"window_end": "2026-10-23T09:00:00Z",
"event_count": 1,
"events": [
{
"id": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a:0",
"summary": "BlackRock CFO resigned.",
"novel": true,
"company": {
"name": "BlackRock",
"rp_entity_id": "HJ95FV"
},
"departure_type": "resignation",
"grounding": [
{
"id": "A97B4203751F",
"headline": "BlackRock CFO steps down",
"source": {
"id": "5E6268",
"name": "Reuters"
},
"url": "https://example.com/blackrock-cfo-steps-down",
"cnum": 0,
"timestamp": "2026-10-23T08:12:00Z"
}
]
}
],
"usage": {
"premium_news_tokens": 1200,
"model_tokens": 800
}
},
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Run not found"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Response too large"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "schedule.frequency: value is not a valid frequency"
}
],
"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"
}
}Path Parameters
Was this page helpful?