Create a monitor

Create a monitor with an intent and schedule. Optionally customize its name, search, extraction rules, output fields, and entity watchlist. Set status to inactive while you test the monitor, then change it to active when it is ready to run continuously.

POST /v1/search-monitoring/monitors

cURL

creditRating

curl --request POST \
  --url https://api.bigdata.com/v1/search-monitoring/monitors \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Credit Rating Downgrade or Negative Watch",
  "intent": "Watch for rating downgrades and negative watch placements affecting BlackRock",
  "status": "inactive",
  "search_queries": {
    "search_mode": "fast",
    "query": {
      "text": "credit rating downgrade negative watch",
      "max_chunks": 100
    }
  },
  "schedule": {
    "frequency": "1h"
  },
  "structured_output": {
    "company": {
      "description": "The company affected by the rating action.",
      "field_type": "entity_reference"
    },
    "rating_agency": {
      "description": "The credit rating agency announcing the action.",
      "field_type": "text"
    },
    "action": {
      "description": "The announced credit rating action.",
      "field_type": "enum",
      "values": [
        "downgrade",
        "negative_watch"
      ]
    },
    "new_rating": {
      "description": "The new rating, when stated.",
      "field_type": "text"
    }
  },
  "extraction_instructions": "Only return a new event when a rating agency announces a downgrade or places the company on negative watch. Exclude analyst recommendations.",
  "entity_watchlist": [
    {
      "name": "BlackRock Inc.",
      "rp_entity_id": "HJ95FV"
    }
  ]
}
'

201

{
  "data": {
    "intent": "<string>",
    "schedule": {
      "frequency": "1h"
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "status": "inactive",
    "search_queries": {
      "search_mode": "fast",
      "query": {}
    },
    "structured_output": {},
    "extraction_instructions": "<string>",
    "entity_watchlist": [
      {
        "name": "<string>",
        "rp_entity_id": "<string>"
      }
    ]
  },
  "metadata": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-KEY · string · header · required

API key created in the Bigdata Developer Platform.

Body

application/json

intent · string · required

Plain-language description of what should count as an event.

schedule · object · required

How often an active monitor searches for new content.

Show child attributes

name · string

Short, recognizable monitor name.

status · enum<string> · default: inactive

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

Available options: active, inactive

search_queries · object

What to search for during each run. Set the search mode and provide the same query object used by Search documents.

Show child attributes

structured_output · object

The fields returned with every event. Each property name becomes a field in the response.

Show child attributes

extraction_instructions · string

Rules explaining what to include, what to exclude, and how to interpret matching content.

entity_watchlist · object[]

Optional set of entities the monitor should track.

Show child attributes

Response

201

application/json

Monitor created.

data · object · required

Show child attributes

metadata · object · required

Show child attributes