Monitor
Objects
Every object and enum the Monitor tools accept.
Was this page helpful?
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Every object and enum the Monitor tools accept.
| Field | Type | Description |
|---|---|---|
cron | string | Five-field cron expression. Minimum interval is 5 minutes. |
text | string | Natural language schedule such as ‘every 30 minutes’ or ‘daily at 9am’. |
timezone | string | IANA timezone for the schedule. The server applies ‘UTC’ when this is absent. |
| Field | Type | Description |
|---|---|---|
id | string | Optional stable ID for this target. Generated if omitted. |
type * | string | Scrape target type. |
urls * | string[] | URLs to scrape on each check. min 1 items |
scrape_options | ScrapeOptionsNested | Scrape options applied to each URL. |
| Field | Type | Description |
|---|---|---|
id | string | Optional stable ID for this target. Generated if omitted. |
type * | string | Crawl target type. |
url * | string | Root URL to crawl on each check. |
crawl_options | CrawlTargetOptions | Crawl options such as limit and includePaths. |
scrape_options | ScrapeOptionsNested | Scrape options applied to each crawled page. |
| Field | Type | Description |
|---|---|---|
limit | integer | Maximum number of pages to crawl. |
max_depth | integer | Maximum crawl depth. |
include_paths | string[] | URL pathname regex patterns to include. |
exclude_paths | string[] | URL pathname regex patterns to exclude. |
| Field | Type | Description |
|---|---|---|
id | string | Optional stable ID for this target. Generated if omitted. |
type * | string | Search target type. |
queries * | string[] | Search queries to run on each check (1-12). min 1 items; max 12 items |
search_window | MonitorSearchWindow | Recency filter for search results. The server applies ‘24h’ when this is absent. |
max_results | integer | Total results to evaluate per check. The server applies 10 when this is absent. ≥ 1; ≤ 50 |
include_domains | string[] | Restrict results to these domains. max 50 items |
exclude_domains | string[] | Drop results from these domains. max 50 items |
| Field | Type | Description |
|---|---|---|
url * | string | The URL to send monitor webhooks to. |
headers | map of string | Headers to send to the webhook URL. |
metadata | object | Custom metadata included in webhook payloads. |
events | MonitorWebhookEvent[] | Monitor webhook events to receive. The server sends all monitor events when this is absent. |
| Field | Type | Description |
|---|---|---|
email | MonitorEmailNotification | Email notification settings. |
| Field | Type | Description |
|---|---|---|
enabled | boolean | Whether email notifications are enabled. |
recipients | string[] | Email recipients for monitor alerts. max 25 items |
includeDiffs | boolean | Include changed page details in email summaries. |
| Value |
|---|
monitor.page |
monitor.check.completed |
| Value |
|---|
queued |
running |
completed |
failed |
partial |
skipped_overlap |
skipped_no_credits |
| Value |
|---|
same |
new |
changed |
removed |
error |
| Value |
|---|
5m |
15m |
1h |
6h |
24h |
7d |
Was this page helpful?