Skip to main content
GET
List checks

Overview

Lists the monitor’s checks, newest first, with each one’s status, page counts and credits. Pass status to filter — status=skipped_no_credits, say, to see when a key ran dry. Open any check with GET /monitor/{id}/checks/{checkId} to see its pages. Checks are kept for the monitor’s retention_days (30 by default) and deleted after that.

Example request

Example response

Streaks

Monitors keep no failure counter. To find out how long something has been going on, count the leading run of a status: the list is newest first, so the checks at the top that share a status are the current streak, and the first check with a different status ends it. actual_credits is what each check was charged — 24 here: 18 pages fetched at 1 credit, plus the 3-credit surcharge on the one page tracking json, plus 3 pages judged at 1. Skipped checks are never charged.

GET /monitor/{id}/checks/{checkId}

What one check found, page by page.

POST /monitor/{id}/run

Run a check now.

Authorizations

X-API-Key
string
header
required

Your Prefetch API key. Obtain one from the dashboard.

Path Parameters

id
string
required

The monitor id returned by POST /monitor.

Example:

"mon_3f9a1c2b7d4e4f6a8b0c1d2e3f4a5b6c"

Query Parameters

limit
integer
default:25

Items to return per request.

Required range: 1 <= x <= 100
offset
integer
default:0

Items to skip. Use the next link rather than building this by hand.

Required range: x >= 0
status
enum<string>

Only checks with this status.

Available options:
queued,
running,
completed,
failed,
partial,
skipped_overlap,
skipped_no_credits

Response

Checks.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required