Skip to main content
POST
web.monitor.create

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
kind
string
required

"page" to watch one web page.

Allowed value: "page"
target
string
required

The public page URL to watch.

schedule
string

Five-field cron expression, UTC unless prefixed with "CRON_TZ= ". Default: every day at 09:00 UTC.

Maximum string length: 120
name
string

A label for the monitor.

Required string length: 1 - 100
purpose
string

What kind of change matters; changes are judged against it.

Required string length: 1 - 2000

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.

ref
string

Reference to what this call created. Pass it as ref to web.monitor.delete.