Skip to main content
GET
Get Monitor

Authorizations

x-api-key
string
header
required

Path Parameters

monitor_id
string<uuid>
required

Response

Successful Response

A monitor.

monitor_id
string<uuid>
required
name
string
required
companies
Companies · object[]
required

Its companies now (a list monitor: its list's).

schedule
Schedule · object
required
settings
Settings · object
required
enabled
boolean
required
kind
string
default:companies

companies or dataset.

dataset
Dataset · object | null

Dataset monitors: topic, columns, mode, max_rows, source_run_id, window_to (where the last complete run ended).

list_id
string<uuid> | null

The company list it follows (companies added to or removed from the list are monitored from the next run on).

query
string | null

What it watches for: a company monitor's query (null: every story), a dataset monitor's research request.

paused_reason
string | null

Why the service paused it: "out_of_credits" (its organization's credits no longer cover it; top up, then resume) or "idle" (the organization's free monitor, its results not opened for 14 days; resume it). Null when running or paused by its user.

last_opened_at
string<date-time> | null

When its owner last opened its runs, stories or rows (the free monitor pauses after 14 days without).

next_run_at
string<date-time> | null

Next scheduled run (UTC).

last_run_id
string<uuid> | null
source_run_id
string<uuid> | null

The run it was made from ("Keep updated", "Monitor this"): its first run.

conversation_id
string<uuid> | null
created_at
string<date-time> | null
updated_at
string<date-time> | null