Skip to main content
POST
web.monitor.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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 web.monitor.create.

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

Response

The result

kind
enum<string>
required

What is watched.

Available options:
page,
topic
target
string
required

Watched page or topic; may contain personal data.

schedule
string
required

Five-field schedule in UTC, or with a time-zone prefix.

status
enum<string>
required

Schedule state.

Available options:
active,
paused,
failed
expiresAt
string

When a bounded monitoring window ends, ISO 8601.

name
string

Monitor name.

createdAt
string

Creation time in ISO 8601.