Skip to main content
GET
Get a check

Overview

Returns one check with a page of its per-page results. Each page carries its status, a diff when it changed, the judge’s verdict when the monitor has a goal, and — in json mode — the full current extraction. Pass status=changed to see only the pages that changed. Results are paginated: follow next until it is null.

Example request

Example response

Check statuses

Reading a page

A page that is new since the first check carries its whole content as an all-added diff. Removed pages carry no diff.

GET /monitor/{id}/checks

Find a check id.

monitor.page webhook

Get the same page objects pushed to you.

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"

checkId
string
required

A check id, from GET /monitor/{id}/checks or POST /monitor/{id}/run.

Example:

"chk_8e2d4f6a1b3c4d5e6f7a8b9c0d1e2f3a"

Query Parameters

skip
integer
default:0

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

Required range: x >= 0
limit
integer
default:25

Page results to return per request.

Required range: 1 <= x <= 100
status
enum<string>

Only pages with this status — changed to see just what changed.

Available options:
same,
new,
changed,
removed,
error

Response

Check with page results.

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