Skip to main content
POST
Check a monitor now

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Any unique string up to 255 visible characters. Send the same key when you retry a request: for 12 hours a repeat returns the first answer again, with an Idempotent-Replayed: true header, without doing the work or charging a second time. A repeat that arrives while the first is still running gets 409 IDEMPOTENCY_IN_PROGRESS; the same key with a different body gets 409 IDEMPOTENCY_KEY_REUSED.

Maximum string length: 255
Example:

"3f2b8c1e-retry-safe-key"

Path Parameters

id
string
required

Response

id
string
required
status
enum<string>
required
Available options:
running,
completed,
partial,
failed,
skipped_no_credits,
skipped_overlap
trigger
enum<string>
required
Available options:
scheduled,
manual
totalPages
number
required

Pages this check reads.

same
number
required
changed
number
required
new
number
required
removed
number
required
error
number
required

Pages we could not read this time. Never counted as a change.

creditsUsed
number
required
startedAt
string
required
finishedAt
string | null
required