List monitors

List monitors

curl --request GET \
  --url https://api.bigdata.com/v1/search-monitoring/monitors \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/v1/search-monitoring/monitors', 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",
  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"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/v1/search-monitoring/monitors")

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": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a",
      "name": "BlackRock exec departures",
      "intent": "Watch for executive departures at BlackRock",
      "status": "inactive",
      "created_at": "2026-10-23T09:00:00Z"
    }
  ],
  "pagination": {
    "has_cursor": false,
    "cursor": null
  },
  "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"
  }
}

GET

search-monitoring

monitors

List monitors

curl --request GET \
  --url https://api.bigdata.com/v1/search-monitoring/monitors \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/v1/search-monitoring/monitors', 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",
  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"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/v1/search-monitoring/monitors")

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": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a",
      "name": "BlackRock exec departures",
      "intent": "Watch for executive departures at BlackRock",
      "status": "inactive",
      "created_at": "2026-10-23T09:00:00Z"
    }
  ],
  "pagination": {
    "has_cursor": false,
    "cursor": null
  },
  "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"
  }
}

Authorizations

X-API-KEY

string

header

required

API key from the Bigdata Developer Platform.

Query Parameters

status

enum<string>

Return only active or only inactive monitors. Leave this out to return both. active runs on the schedule. inactive keeps the setup and does not start new scheduled runs.

Available options:

active,

inactive

name

string

Match monitors whose name contains this text. Matching ignores case.

intent

string

Match monitors whose intent contains this text. Matching ignores case.

limit

integer

default:50

How many monitors to return. The default is 50, and the maximum is 200.

Required range: 1 <= x <= 200

Response

Monitors returned.

results

object[]

required

Show child attributes

pagination

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

Query Parameters

Response