Skip to main content
Every pass over a monitor’s pages is a check. A check holds one result for each page: same, new, changed, removed or error. A page that changed comes with its diff. You can read all of it whether or not you use a webhook, and every read is free.

List the checks

Get an API key in the Quickstart. The samples read the monitor’s id from MONITOR_ID. GET /v1/monitor/{id}/checks lists the checks of one monitor, newest first.
This real answer is the first check of a monitor, cut to the fields that matter. It read one page for the first time, so the page is new.
A check that stays running for 30 minutes is shown as failed. Send status to keep one status, limit up to 100 (20 by default) and offset to skip checks. A monitor keeps its last 1,000 checks for its retentionDays.

Read one check

GET /v1/monitor/{id}/checks/{checkId} returns the check with a result for each page, and the diff of each changed page. Use the id of a check from the list, or from Run now.
This real answer is a check that found a changed page, cut to the fields that matter. The monitor had a goal, so the page holds a judgment, and the check cost $0.002: $0.001 for the page and $0.001 for the judge.
A check holds up to 100 pages in one answer. Send limit and skip, or call the address in next until it is null. Send status to keep the pages with one status, such as changed.

Page statuses

Search results

For a search target, each page is a result. metadata.searchStatus says what happened to it. This real result was read and judged, and the judge decided it did not match the goal.

List the changes

GET /v1/monitor/{id}/changes lists the page results of a monitor, newest first: one row for each page in each check. Send status=changed to keep the changes. Send url to keep one page.
A monitor keeps its last 1,000 rows for its retentionDays.

Read all monitors at once

Two calls cover every monitor you have. GET /v1/monitor/checks lists checks across monitors. Filter with monitorId, status, trigger (scheduled or manual), limit up to 100 and cursor. The answer holds data.checks and data.cursor. GET /v1/monitor/changes lists page results across monitors. Filter with monitorId, status, url, limit up to 100 and cursor. Each row also has its id and its monitorId and monitorName. This real answer listed three rows, two of them new first reads. It is cut to the changed row.
The list leaves out the diff. GET /v1/monitor/changes/{id} reads one row with its diff, and its json when the monitor compares fields.

Limits and errors

  • A monitor id that does not exist, or a check or change id that is not yours or has expired, returns 404 notFound.
  • A cursor that is not the one from the last answer returns 400 invalidRequest. Send it unchanged.
  • A change id comes from the account-wide list. A monitor keeps its last 1,000 rows for its retentionDays, and an older id returns 404 notFound.

Price

Free. Reading checks and changes costs nothing. The pages a check reads are charged when the check runs, at the price in Monitors.