Monitors API endpoint
Use Crawlora's Create a Website-Change Monitor API to extract supported public Monitors data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/monitorsCreates a monitor that periodically checks a page or sitemap for changes and can notify a webhook. Free to call -- only completed check runs (services/webmonitor's cron-driven scrape/sitemap fetch) consume credits, at 1 credit per completed run regardless of target type or whether a change was detected. `target_type` defaults to "page" (exact-fingerprint diff of the scraped page). "sitemap" watches the sitemap at `url` for added/removed entries instead, honoring `sitemap.include_patterns`/`exclude_patterns` (shell-style globs matched against each URL's path) and `sitemap.max_urls` (default 5000, hard cap 10000). Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| Authorization (header) | string | No | Dashboard JWT in the form `Token <jwt>` (use this or x-api-key) | ||
| x-api-key (header) | string | No | API key (alternative to a dashboard JWT) | ||
| request (body) | object | Yes | Monitor definition |
curl -X POST "https://api.crawlora.net/api/v1/monitors" \
-H "x-api-key: $CRAWLORA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"cadence_minutes":60,"enabled":true,"name":"Pricing page","notification":{"events":["change.detected","run.completed"],"webhook_secret":"whsec_...","webhook_url":"https://example.com/webhooks/crawlora"},"sitemap":{"exclude_patterns":["/blog/*"],"include_patterns":["/products/*"],"max_urls":5000},"target_type":"page","url":"https://example.com/pricing"}'This endpoint accepts a signed-in JWT session through the console proxy or an x-api-key header.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Invalid parameters | #/definitions/app.Response |
| 401 | Authentication required | #/definitions/app.Response |
| 500 | Internal server error | #/definitions/app.Response |
{
"cadence_minutes": 60,
"enabled": true,
"name": "Pricing page",
"notification": {
"events": [
"change.detected",
"run.completed"
],
"webhook_secret": "whsec_...",
"webhook_url": "https://example.com/webhooks/crawlora"
},
"sitemap": {
"exclude_patterns": [
"/blog/*"
],
"include_patterns": [
"/products/*"
],
"max_urls": 5000
},
"target_type": "page",
"url": "https://example.com/pricing"
}{
"code": 200,
"msg": "OK",
"data": {
"id": "66d2f0b1c2a4e5f6a7b8c9d0",
"url": "https://example.com/pricing",
"name": "Pricing page",
"target_type": "page",
"cadence_minutes": 60,
"enabled": true,
"notification": {
"webhook_url": "https://example.com/webhooks/crawlora",
"events": [
"change.detected"
]
},
"next_check_at": "2026-08-22T11:00:00Z",
"failures": 0,
"created_at": "2026-08-22T10:00:00Z",
"updated_at": "2026-08-22T10:00:00Z"
}
}Request schema
#/definitions/webmonitor.createMonitorBodyDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| cadence_minutes | integer | No | 60 | |||
| enabled | boolean | No | true | |||
| name | string | No | Pricing page | |||
| notification | webmonitor.notificationBodyDoc | No | ||||
| notification.events | array | No | change.detected,run.completed | |||
| notification.webhook_secret | string | No | whsec_... | |||
| notification.webhook_url | string | No | https://example.com/webhooks/crawlora | |||
| sitemap | webmonitor.sitemapTargetBodyDoc | No | ||||
| sitemap.exclude_patterns | array | No | /blog/* | |||
| sitemap.include_patterns | array | No | /products/* | |||
| sitemap.max_urls | integer | No | 5000 | |||
| target_type | string | No | page, sitemap | page | ||
| url | string | No | https://example.com/pricing |
Response schema
#/definitions/webmonitor.monitorResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | webmonitor.monitorDoc | No | ||||
| data.cadence_minutes | integer | No | 60 | |||
| data.created_at | string | No | 2026-08-01T00:00:00Z | |||
| data.enabled | boolean | No | true | |||
| data.failures | integer | No | 0 | |||
| data.id | string | No | 66d2f0b1c2a4e5f6a7b8c9d0 | |||
| data.last_changed_at | string | No | 2026-08-20T09:00:00Z | |||
| data.last_checked_at | string | No | 2026-08-22T10:00:00Z | |||
| data.last_error | string | No | ||||
| data.name | string | No | Pricing page | |||
| data.next_check_at | string | No | 2026-08-22T11:00:00Z | |||
| data.notification | webmonitor.notificationDoc | No | ||||
| data.notification.events | array | No | change.detected,run.completed | |||
| data.notification.webhook_url | string | No | https://example.com/webhooks/crawlora | |||
| data.sitemap | webmonitor.sitemapTargetDoc | No | ||||
| data.sitemap.exclude_patterns | array | No | /blog/* | |||
| data.sitemap.include_patterns | array | No | /products/* | |||
| data.sitemap.max_urls | integer | No | 5000 | |||
| data.target_type | string | No | page, sitemap | page | ||
| data.updated_at | string | No | 2026-08-22T10:00:00Z | |||
| data.url | string | No | https://example.com/pricing | |||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X POST "https://api.crawlora.net/api/v1/monitors" \
-H "x-api-key: $CRAWLORA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"cadence_minutes":60,"enabled":true,"name":"Pricing page","notification":{"events":["change.detected","run.completed"],"webhook_secret":"whsec_...","webhook_url":"https://example.com/webhooks/crawlora"},"sitemap":{"exclude_patterns":["/blog/*"],"include_patterns":["/products/*"],"max_urls":5000},"target_type":"page","url":"https://example.com/pricing"}'Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms