Create a monitor

Create a monitor from what you want to track and how often to check.

Only intent and schedule are required. Anything you leave out is filled in from the intent. status defaults to inactive, so you can test before it runs on a schedule. A new monitor does not send email. Add email later with an update.

If the intent cannot be monitored, the request is rejected.

POST /v1/search-monitoring/monitors

cURL

executiveDeparture

curl --request POST \
  --url https://api.bigdata.com/v1/search-monitoring/monitors \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "intent": "Watch for executive departures at BlackRock",
  "name": "BlackRock exec departures",
  "status": "inactive",
  "search_queries": {
    "search_mode": "fast",
    "query": {
      "text": "executive departure",
      "max_chunks": 100,
      "filters": {
        "entity": {
          "any_of": [
            "HJ95FV"
          ]
        }
      }
    },
    "response_detail": "standard"
  },
  "schedule": {
    "frequency": "1h"
  },
  "structured_output": {
    "company": {
      "description": "The company the executive is leaving.",
      "field_type": "entity_reference"
    },
    "departure_type": {
      "field_type": "enum",
      "values": [
        "resignation",
        "termination",
        "retirement"
      ]
    }
  },
  "extraction_instructions": "Treat an interim appointment as a departure of the outgoing executive.",
  "watchlists": [
    {
      "entities": [
        "HJ95FV"
      ]
    }
  ]
}
'

201

{
  "data": {
    "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",
    "search_queries": {
      "search_mode": "fast",
      "query": {
        "text": "executive departure",
        "max_chunks": 100,
        "filters": {
          "entity": {
            "any_of": [
              "HJ95FV"
            ]
          }
        }
      },
      "response_detail": "standard"
    },
    "schedule": {
      "frequency": "1h"
    },
    "structured_output": {
      "company": {
        "description": "The company the executive is leaving.",
        "field_type": "entity_reference"
      },
      "departure_type": {
        "field_type": "enum",
        "values": [
          "resignation",
          "termination",
          "retirement"
        ]
      }
    },
    "extraction_instructions": "Treat an interim appointment as a departure of the outgoing executive.",
    "watchlists": [
      {
        "entities": [
          "HJ95FV"
        ]
      }
    ],
    "delivery": null
  },
  "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.

Body

application/json

What to track, and how often. Only intent and schedule are required. Other fields are filled in from the intent when you leave them out.

intent · string · required

What should count as an event, in plain language. This is fixed once the monitor is created.

schedule · object · required

How often an active monitor checks for new content.

Show child attributes

name · string

A short name you will recognize. If you leave it out, one is written from the intent.

status · enum<string> · default: inactive

Defaults to inactive. Set active to start the schedule and queue the first run.

Available options: active, inactive

search_queries · Single search query · object

The search to run. If you leave it out, one is written from the intent. Send a single search query, or a list of search queries.

Single search query · object

List of search queries · object[]

Show child attributes

Example:

{
  "search_mode": "fast",
  "query": {
    "text": "executive departure",
    "max_chunks": 100,
    "filters": { "entity": { "any_of": ["HJ95FV"] } }
  },
  "response_detail": "standard"
}

structured_output · object

Fields to extract for each event. If you leave this out, the fields are written from the intent.

Show child attributes

Example:

{
  "company": {
    "description": "The company the executive is leaving.",
    "field_type": "entity_reference"
  },
  "departure_type": {
    "field_type": "enum",
    "values": ["resignation", "termination", "retirement"]
  }
}

extraction_instructions · string | null

Extra rules for what to include or leave out. If you leave this out, rules may be written from the intent.

watchlists · object[] | null

Entity IDs to focus on. If you leave this out, a watchlist may be written from the intent. Send null for no watchlist.

Show child attributes

Response

201

application/json

The monitor was created. The new monitor is in data. Save data.id.

data · object · required

The full monitor returned when you create, read, or update one.

Show child attributes

metadata · object · required

Show child attributes