Skip to main content
A monitor checks your targets on a schedule and records what changed.
name, targets and schedule are required. Creating is free, but every check bills for each page it reads until you pause or delete the monitor. See Pricing.
The monitor is in data. The first check starts at once: page targets record a baseline and report no change, and a search target can report results. To be told about changes, add a webhook. urls, interval, formats, changeTracking, nextCheckAt and lastCheckAt repeat other fields for older clients.

Manage a monitor

All of these are free. A monitor that does not exist, or belongs to another account, returns 404 notFound.

Set the schedule

Send text or cron in schedule, not both, with an optional IANA timezone (default UTC) that sets what a time means. A daily time comes back as a cron expression.
A cron expression has five fields, minute to weekday, and runs no closer than 5 minutes apart. The older interval field takes seconds, or 30m, 6h, 1d, and works only with url and urls. Checks of one monitor never overlap: a check that falls due while the last one runs is recorded as skipped_overlap and is free.

Run, pause and resume

POST /v1/monitor/{id}/run queues a check outside the schedule, which does not move. It returns the check with status: "queued", trigger: "manual" and estimatedCostUsd. Read it with GET /v1/monitor/{id}/checks/{checkId}. A manual check costs the same as a scheduled one. PATCH with "status": "paused" stops checks and keeps history. "status": "active" resumes with a check at once. Changing the schedule of a paused monitor keeps it paused.
  • When your balance runs out, the monitor pauses with pausedReason: "insufficientCredits" and sends monitor.failed if you subscribed. Add funds, then resume.
  • A page that cannot be read is error and free, and the monitor keeps running. After 5 failed checks in a row on the same page, monitor.failed is sent once.
  • A check where every page failed for lack of balance is skipped_no_credits.

Limits

GET /v1/monitor/limits returns these as monitors, pages, perMonitor and intervalSeconds. Call rates are on Rate limits. GET /v1/monitor/usage totals what checks cost per monitor, highest first, including deleted ones (deleted: true). Send from and to as an ISO date or time, with to excluded and at most 366 days between them. The default is the last 30 days.

Errors

Each error below is 400 invalidRequest unless its code says otherwise. A failed call is free. Other codes are on Errors. Target and webhook errors are on Targets and Checks, changes and webhooks.

Next