Update a monitor

Change the fields you send. Leave a field out to keep its current value.

intent cannot be changed. To track something else, create a new monitor.

Changing the search, output fields, watchlists, or extraction instructions clears this monitor’s history. Later runs treat matching events as new. Changing the name, status, schedule, or email delivery keeps the history. Sending back the same search you received from Get monitor details does not count as a change.

PATCH /v1/search-monitoring/monitors/{monitor_id}

cURL

activate

curl --request PATCH \
  --url https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "status": "active"
}
'

200

{
  "data": {
    "id": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a",
    "name": "BlackRock exec departures",
    "intent": "Watch for executive departures at BlackRock",
    "status": "active",
    "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": {
      "type": "email"
    }
  },
  "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.

Path Parameters

monitor_id · string<uuid> · required

Id returned when you created the monitor.

Body

application/json

Fields you can change. Leave a field out to keep its current value. intent cannot be changed.

name · string

A new name.

status · enum<string>

Set active to start scheduled runs, or inactive to pause them. Switching on queues the first run.

Available options: active, inactive

search_queries · Single search query · object

Replace the search with 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"
}

schedule · object

How often to check.

Show child attributes

structured_output · object | null

Replace the fields to extract, or send null to remove them.

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

Replace the extra rules, or send null to clear them.

watchlists · object[] | null

Replace the watchlists, or send null to clear them.

Show child attributes

delivery · object | null

Set type to email to email you, or send null to turn email off.

Show child attributes

Response

200

application/json

Monitor updated.

data · object · required

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

Show child attributes

metadata · object · required

Show child attributes