Skip to main content
PATCH

Authorizations

X-API-KEY
string
header
required

API key created in the Bigdata Developer Platform.

Path Parameters

monitor_id
string<uuid>
required

Unique identifier for the monitor.

Body

application/json

Monitor settings that can be changed. Omitted fields remain unchanged. intent is fixed when the monitor is created and cannot be updated.

name
string

A short, recognizable name for the monitor.

status
enum<string>

active runs on schedule. inactive keeps its configuration but does not start new scheduled runs.

Available options:
active,
inactive
search_queries
object

A replacement search mode and Search documents query.

schedule
object

How often the active monitor should run.

structured_output
object

The fields to extract for each event.

extraction_instructions
string

Rules explaining which events to include or exclude.

entity_watchlist
object[]

The complete list of entities to track.

Response

Monitor updated.

data
object
required
metadata
object
required