Skip to main content
POST
web.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 monitor to change.

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

A new five-field cron expression for the checks. Only a cadence that can be kept exactly is accepted: "0 * * * *" every hour, or every 2, 3, 4, 6, 8 or 12 hours as "0 */N * * *". The checks run every N hours counted from the moment the monitor is created, not at fixed clock times; a fixed hour, a weekday, a day of the month or a time zone is not accepted. A schedule that would cost more than the monitor costs now is not accepted; cancel and create it again instead.

Maximum string length: 120
target
string

A new query for a topic monitor to watch. A monitor watching a research result cannot change what it watches.

Required string length: 1 - 2048
name
string

A new label for the monitor.

Required string length: 1 - 100

Response

The result

kind
enum<string>
required

What is watched: a page or a search topic.

Available options:
page,
topic
target
string
required

The page URL or the search query.

schedule
string
required

Five-field cron expression the checks run on.

expiresAt
string

When a bounded monitoring window ends, ISO 8601; renew by creating another window.

name
string

The monitor's label.

status
enum<string>

Current state of the monitor.

Available options:
active,
paused,
failed
createdAt
string

When the monitor was created, ISO 8601.