Skip to main content
POST

Price

$1 per 1,000 pages read, for every check. A json mode adds $3 per 1,000 pages when it returns something, and a judged change adds $1 per 1,000 pages. See Pricing.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
origin
string

Set by client libraries. Ignored.

Maximum string length: 200
integration
string

Set by client libraries. Ignored.

Maximum string length: 200
name
string

A name for the monitor.

Required string length: 1 - 256
schedule
object
targets
object[]
Required array length: 1 - 50 elements
goal
string | null

What matters to you, in plain words. With a goal, every changed page is judged against it ($1 per 1,000 pages more for each changed page) and the page says whether the change is meaningful. judgeEnabled false turns the judge off.

Maximum string length: 2000
judgeEnabled
boolean
retentionDays
integer

How many days checks, diffs and snapshots are kept. 30 by default.

Required range: 1 <= x <= 365
webhook
object
notification
object
url
string

The page to watch. The older way: use targets.

urls
string[]

The pages to watch, up to 100. The older way: use targets.

Required array length: 1 - 100 elements
interval

How often to check, at least every 5 minutes: seconds, or text such as 30m, 6h, 1d. The older way: use schedule.

Required range: -9007199254740991 <= x <= 9007199254740991
formats
enum<string>[]

What to compare. The older way: use targets.

Minimum array length: 1
Available options:
markdown,
html,
rawHtml,
links
changeTracking
object

Response

The monitor, with its next run.

success
any
required
creditsUsed
integer
required
costUsd
number
required

What this call cost, in dollars.

requestId
string
required
id
string
data
object
next
string | null