[Go to site: main page, start]

Skip to main content
PATCH
JavaScript
0 Credits
Updating target or change_detection resets the monitor’s baseline: the next run re-captures it instead of reporting a spurious change. Unsupported target/change detection combinations are rejected — supported pairs are page + exact, page + semantic, sitemap + exact, and extract + semantic.Adding target.instructions to an exact page monitor (without also passing change_detection) flips it to semantic automatically, matching the create-time default. Passing change_detection: { type: "exact" } alongside instructions, or clearing instructions on a semantic page monitor, is rejected.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

Path Parameters

monitor_id
string
required
Example:

"mon_123"

Body

application/json

Shared monitor update fields. target and change_detection can be updated, but the final combination must be supported.

name
string
Required string length: 1 - 200
Example:

"Acme pricing monitor"

tags
string[]

User-defined tags for grouping and filtering monitors and their changes. Duplicates are removed.

Maximum array length: 20
Required string length: 1 - 50
Example:
status
enum<string>
Available options:
active,
paused
target
Page target · object

Discriminated union describing what the monitor watches.

change_detection
Exact · object

Discriminated union describing how changes are detected.

schedule
Interval · object

Discriminated union describing how the monitor is scheduled. Only interval is supported today; cron and exact_time are reserved for future use.

webhook
object | null

Set to null to remove the webhook.

Response

Updated monitor

A web monitor. mode is the constant web; behavior is described by target (page/sitemap/extract) and change_detection (exact/semantic).

mode
enum<string>
required

Top-level monitor category. Always web today; the concrete behavior is described by target and change_detection.

Available options:
web
id
string
required
Example:

"mon_123"

name
string
required
Example:

"Acme pricing monitor"

target
Page target · object
required

Discriminated union describing what the monitor watches.

change_detection
Exact · object
required

Discriminated union describing how changes are detected.

schedule
Interval · object
required

Discriminated union describing how the monitor is scheduled. Only interval is supported today; cron and exact_time are reserved for future use.

status
enum<string>
required

Monitor lifecycle status. failed means the most recent run failed (see the monitor's last_error); failed monitors keep running on schedule and flip back to active on the next successful run. Monitors are auto-paused after repeated consecutive failures or insufficient-credit skips; resume by PATCHing status to active.

Available options:
active,
paused,
failed
created_at
string<date-time>
required
updated_at
string<date-time>
required
webhook
object | null
last_run_at
string<date-time> | null
last_change_at
string<date-time> | null
next_run_at
string<date-time> | null

When the next scheduled run is due.

last_error
object | null

Error from the most recent failed run; null when the last run succeeded.

webhook_failure
object | null

Present while webhook deliveries are failing consecutively; null when deliveries are healthy or no webhook is configured. Cleared on the next successful delivery and when the webhook URL changes.

tags
string[]

User-defined tags for grouping and filtering monitors and their changes. Duplicates are removed.

Maximum array length: 20
Required string length: 1 - 50
Example:
baseline
Page baseline · object

Current baseline: the last observed value the monitor compares new snapshots against. Its shape follows target.type (page/sitemap/extract). Only populated on GET /monitors/{monitor_id}; null until the first baseline run completes (and after a target or change_detection update, which resets the baseline).