Objects - Charter Docs

Model tree

MonitorSchedule

MonitorScrapeTarget

MonitorEmailNotification

MonitorSchedule

Schedule for monitor checks. Provide either cron or text.

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.

MonitorScrapeTarget

Monitor target that scrapes one or more URLs on each check.

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
`scrapeOptions`	ScrapeOptionsNested	Scrape options applied to each URL.

MonitorCrawlTarget

Monitor target that crawls a site on each check.

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.
`crawlOptions`	CrawlTargetOptions	Crawl options such as limit and includePaths.
`scrapeOptions`	ScrapeOptionsNested	Scrape options applied to each crawled page.

CrawlTargetOptions

Crawl options attached to a monitor crawl target.

Field	Type	Description
`limit`	`integer`	Maximum number of pages to crawl.
`maxDepth`	`integer`	Maximum crawl depth.
`includePaths`	`string`[]	URL pathname regex patterns to include.
`excludePaths`	`string`[]	URL pathname regex patterns to exclude.

MonitorSearchTarget

Monitor target that runs web search queries on each check.

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
`searchWindow`	MonitorSearchWindow	Recency filter for search results. The server applies ‘24h’ when this is absent.
`maxResults`	`integer`	Total results to evaluate per check. The server applies 10 when this is absent. ≥ 1; ≤ 50
`includeDomains`	`string`[]	Restrict results to these domains. max 50 items
`excludeDomains`	`string`[]	Drop results from these domains. max 50 items

MonitorWebhook

Webhook destination for monitor page and check completion events.

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.

MonitorNotification

Notification destinations for a monitor.

Field	Type	Description
`email`	MonitorEmailNotification	Email notification settings.

MonitorEmailNotification

Email notification settings for a monitor.

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.

MonitorWebhookEvent

Value
`monitor.page`
`monitor.check.completed`

MonitorCheckStatus

Value
`queued`
`running`
`completed`
`failed`
`partial`
`skipped_overlap`
`skipped_no_credits`

MonitorPageStatus

Value
`same`
`new`
`changed`
`removed`
`error`

MonitorSearchWindow

Value
`5m`
`15m`
`1h`
`6h`
`24h`
`7d`

​Model tree

​MonitorSchedule

​MonitorScrapeTarget

​MonitorCrawlTarget

​CrawlTargetOptions

​MonitorSearchTarget

​MonitorWebhook

​MonitorNotification

​MonitorEmailNotification

​MonitorWebhookEvent

​MonitorCheckStatus

​MonitorPageStatus

​MonitorSearchWindow

Model tree

MonitorSchedule

MonitorScrapeTarget

MonitorCrawlTarget

CrawlTargetOptions

MonitorSearchTarget

MonitorWebhook

MonitorNotification

MonitorEmailNotification

MonitorWebhookEvent

MonitorCheckStatus

MonitorPageStatus

MonitorSearchWindow