Skip to main content
POST
data.monitor.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by data.monitor.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
status
enum<string>

active resumes the monitor; paused stops it until you resume it.

Available options:
active,
paused
everyHours
integer

A new schedule, in hours. A realtime monitor runs at most daily.

Required range: 1 <= x <= 744
maxResultsPerRun
integer

A new per-run cap. Above 1,000 the run is delivered as one file.

Required range: 1 <= x <= 10000
refreshFrequencyDays

Watched-list people only: how many days fresh the tracked data is kept. A fresher tier costs more per changed person and is declined when it would raise the monitor's monthly worst case.

entities
object

Watched-list monitors only: replaces the watched list with these entities. People newly added are baselined silently, so adding one never fires a spurious delivery.

label
string

A new label for the monitor.

Required string length: 1 - 100

Response

The result

kind
enum<string>
required

A saved search (discovery) or a watched list (entity).

Available options:
discovery,
entity
dataset
enum<string>
required

What kind of record the monitor delivers.

Available options:
company,
person,
job,
social_post
everyHours
number
required

The schedule: the monitor runs every N hours.

maxResultsPerRun
number
required

Records delivered per run, at most.

status
enum<string>

Current state of the monitor.

Available options:
active,
paused,
suspended,
expired,
cancelled
realtime
boolean

True when every run searches live (the 1-day tier) instead of the index.

refreshDays
number

How many days fresh the tracked data is kept (watched-list monitors).

label
string

The monitor's label.

createdAt
string

When the monitor was created, ISO 8601.

lastRunAt
string

When the monitor last ran, ISO 8601.