Create a monitor

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mode: 'web',
    name: 'Acme pricing page',
    target: {type: 'page', url: 'https://acme.com/pricing'},
    change_detection: {type: 'exact'},
    schedule: {type: 'interval', frequency: 6, unit: 'hours'},
    webhook: {url: 'https://example.com/webhook'}
  })
};

fetch('https://api.context.dev/v1/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "mode": "web",
  "id": "mon_123",
  "name": "Acme pricing monitor",
  "target": {
    "type": "page",
    "url": "https://acme.com/pricing",
    "instructions": "Report pricing or plan availability changes. Ignore counters, timestamps, testimonials, and navigation.",
    "normalize_whitespace": true,
    "include_selectors": [
      "#attraction-details"
    ],
    "exclude_selectors": [
      ".carousel",
      "[id^=\"TA_\"]"
    ],
    "actions": [
      {
        "do": "wait",
        "timeMs": 15000
      }
    ]
  },
  "change_detection": {
    "type": "exact"
  },
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "initial_run_id": "run_123",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "schedule": {
    "type": "interval",
    "frequency": 6,
    "unit": "hours"
  },
  "webhook": {
    "url": "https://example.com/webhook",
    "events": [
      "change.detected",
      "run.completed"
    ],
    "retry": {
      "delays_seconds": [
        10,
        60,
        300,
        1800,
        7200,
        21600,
        57600
      ]
    },
    "secret": "whsec_8f3a…"
  },
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_change_at": "2023-11-07T05:31:56Z",
  "next_run_at": "2023-11-07T05:31:56Z",
  "last_error": {
    "code": "fetch_failed",
    "message": "The target URL could not be fetched."
  },
  "webhook_failure": {
    "consecutive_failures": 3,
    "last_status": "rejected",
    "last_message": "Webhook endpoint returned HTTP 429.",
    "last_failed_at": "2023-11-07T05:31:56Z"
  },
  "tags": [
    "pricing",
    "competitor"
  ],
  "baseline": {
    "text": "Acme Pricing\nStarter $9/mo…",
    "captured_at": "2023-11-07T05:31:56Z"
  },
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "RATE_LIMITED",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

POST

monitors

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mode: 'web',
    name: 'Acme pricing page',
    target: {type: 'page', url: 'https://acme.com/pricing'},
    change_detection: {type: 'exact'},
    schedule: {type: 'interval', frequency: 6, unit: 'hours'},
    webhook: {url: 'https://example.com/webhook'}
  })
};

fetch('https://api.context.dev/v1/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "mode": "web",
  "id": "mon_123",
  "name": "Acme pricing monitor",
  "target": {
    "type": "page",
    "url": "https://acme.com/pricing",
    "instructions": "Report pricing or plan availability changes. Ignore counters, timestamps, testimonials, and navigation.",
    "normalize_whitespace": true,
    "include_selectors": [
      "#attraction-details"
    ],
    "exclude_selectors": [
      ".carousel",
      "[id^=\"TA_\"]"
    ],
    "actions": [
      {
        "do": "wait",
        "timeMs": 15000
      }
    ]
  },
  "change_detection": {
    "type": "exact"
  },
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "initial_run_id": "run_123",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "schedule": {
    "type": "interval",
    "frequency": 6,
    "unit": "hours"
  },
  "webhook": {
    "url": "https://example.com/webhook",
    "events": [
      "change.detected",
      "run.completed"
    ],
    "retry": {
      "delays_seconds": [
        10,
        60,
        300,
        1800,
        7200,
        21600,
        57600
      ]
    },
    "secret": "whsec_8f3a…"
  },
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_change_at": "2023-11-07T05:31:56Z",
  "next_run_at": "2023-11-07T05:31:56Z",
  "last_error": {
    "code": "fetch_failed",
    "message": "The target URL could not be fetched."
  },
  "webhook_failure": {
    "consecutive_failures": 3,
    "last_status": "rejected",
    "last_message": "Webhook endpoint returned HTTP 429.",
    "last_failed_at": "2023-11-07T05:31:56Z"
  },
  "tags": [
    "pricing",
    "competitor"
  ],
  "baseline": {
    "text": "Acme Pricing\nStarter $9/mo…",
    "captured_at": "2023-11-07T05:31:56Z"
  },
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "RATE_LIMITED",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

1, 2, or 10 credits per run Requires monitors:write 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.

Body

application/json

Monitor target, detection method, and schedule. Omitted schedules run daily.

name

string

required

Display name for the monitor.

Required string length: 1 - 200

Example:

"Acme pricing monitor"

target

Page target · object

required

What to watch: a page, a sitemap, or data extracted from a site.

Page target
Sitemap target
Extract target

Show child attributes

mode

enum<string>

Always web. Optional.

Available options:

web

Response

Monitor created

mode

enum<string>

required

Always web. Optional.

Available options:

web

string

required

Example:

"mon_123"

name

string

required

Example:

"Acme pricing monitor"

target

Page target · object

required

What to watch: a page, a sitemap, or data extracted from a site.

Page target
Sitemap target
Extract target

Show child attributes

change_detection

Exact · object

required

How changes are judged. Defaults to semantic for extract targets and page targets with instructions, otherwise exact.

Exact
Semantic

Show child attributes

status

enum<string>

required

Current state. Failed monitors keep running; paused monitors must be resumed with status: "active".

Available options:

active,

paused,

failed

created_at

string<date-time>

required

updated_at

string<date-time>

required

initial_run_id

string | null

required

ID of the baseline run queued at creation; null if it will start on the next scheduled tick.

Example:

"run_123"

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"

schedule

Interval · object

How often the monitor runs. Defaults to once a day.

Show child attributes

webhook

object | null

Webhook destination and delivery settings. Null means no webhook is configured.

Show child attributes

last_run_at

string<date-time> | null

last_change_at

string<date-time> | null

next_run_at

string<date-time> | null

When the next scheduled run is due; null while paused.

last_error

object | null

Error from the most recent failed run; null when the last run succeeded.

Show child attributes

webhook_failure

object | null

Present while webhook deliveries are failing consecutively; null when deliveries are healthy or no webhook is configured. Cleared on the next successful delivery and when the webhook URL changes.

Show child attributes

Web Data

Brand Data

People & News

Batches

Monitors

Webhook Deliveries

Request Logs

Agent Feedback

Authorizations

Body

Response