API ReferenceMonitors

Get monitor

GET
/v1/monitors/{id}

Authorization

AuthorizationRequiredBearer <token>

API key. Obtain from POST /v1/account/api-keys.

In: header

Path Parameters

idRequiredstring
Pattern: "^mon_"
curl -X GET "https://api.bytekit.com/v1/monitors/string" \
  -H "Authorization: Bearer <token>"

Successful response.

{
  "id": "mon_01j9abc123",
  "type": "screenshot",
  "url": "string",
  "status": "active",
  "interval_type": "hourly",
  "cron_expression": "string",
  "next_capture_at": "2019-08-24T14:15:22Z",
  "notify_on": "string",
  "webhook_url": "string",
  "webhook_headers": {},
  "change_threshold": "string",
  "scrape_options": null,
  "last_content_hash": "string",
  "captures_count": 0,
  "changes_count": 0,
  "skipped_captures": 0,
  "last_captured_at": "2019-08-24T14:15:22Z",
  "last_changed_at": "2019-08-24T14:15:22Z",
  "consecutive_failures": 0,
  "last_error_code": "string",
  "suspension_reason": "string",
  "metadata": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "cancelled_at": "2019-08-24T14:15:22Z"
}

Create a change-detection monitor

Creates a recurring change-detection monitor for a URL. Webhook deliveries include `X-RapidCrawl-Event: monitor.change_detected` or `X-RapidCrawl-Event: monitor.captured` so receivers can dispatch on the header without parsing the body shape. Scrape-monitor webhook payloads carry an additive `was_preflight: boolean` field. It is `true` only when the cycle confirmed the page was unchanged (the target returned HTTP 304) — emitted as a heartbeat under `notify_on='every'`. On the `notify_on='change'` delivery path, unchanged cycles suppress the webhook entirely. The field is `false` on every other delivery, including all captures that carry a body.

Update monitor

Next Page