Skip to main content
GET
Retrieve a monitor run
0 credits Requires monitors:read permission. See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Path Parameters

monitor_id
string
required

ID of the monitor.

Example:

"mon_123"

run_id
string
required

ID of the monitor run.

Example:

"run_123"

Response

The requested monitor run

id
string
required
Example:

"run_123"

monitor_id
string
required
Example:

"mon_123"

status
enum<string>
required

Lifecycle status of a run. skipped runs never executed — see skip_reason (insufficient credits, monitor paused, or superseded by a concurrent run).

Available options:
queued,
running,
completed,
failed,
skipped
run_type
enum<string>
required

A baseline run follows creation or a target or detection change.

Available options:
baseline,
scheduled
target_type
enum<string>
required
Available options:
page,
sitemap,
extract
change_detection_type
enum<string>
required
Available options:
exact,
semantic
change_detected
boolean
required
Example:

true

baseline_created
boolean
required

True when this run established the monitor's initial baseline; baseline runs perform no change detection.

credits_charged
integer
required

Credits charged for this run (0 for skipped/failed runs).

Required range: x >= 0
Example:

1

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

webhook_delivery_ids
string[]

Webhook delivery IDs for this run.

started_at
string<date-time> | null
completed_at
string<date-time> | null
change_id
string | null
Example:

"chg_123"

skip_reason
enum<string> | null

Why a skipped run never executed; null unless status is skipped.

Available options:
insufficient_credits,
monitor_paused,
superseded,
null
error
object | null
webhook_delivery
object
deprecated

Deprecated. Use webhook_deliveries for all attempts.

webhook_deliveries
object[]

All webhook deliveries attempted by this run — one per subscribed event that fired. Omitted when no webhook was attempted, including runs created before event selection was added.

key_metadata
object

Credits this request used and your remaining balance.