API ReferenceMonitors

List monitors

GET
/v1/monitors

Authorization

AuthorizationRequiredBearer <token>

API key. Manage keys from the dashboard at app.bytekit.com.

In: header

Query Parameters

limitinteger
Default: 25Minimum: 1Maximum: 100
cursorstring

Pagination cursor from a previous response.

statusstring
Default: "active"Value in: "active" | "processing" | "paused" | "cancelled" | "suspended"
curl https://api.bytekit.com/v1/monitors \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Successful response.

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}

Monitors

Monitors API — endpoints, requests, and responses.

POST /v1/monitorsCreate a change-detection monitor

Creates a recurring change-detection monitor for a URL, delivering results via webhook. **Limits:** request bodies are capped at 512 KB. An oversized body returns a `400` with error code `request_too_large`.