API ReferenceMonitors

Retrieve monitor

View as Markdown

Authentication

AuthorizationBearer
Your API key, sent as a Bearer token.

Path parameters

monitor_idstringRequired

Response

Successful Response
idstring
Monitor identifier.
querystring
The tracked query.
cadencestring
hourly, daily or weekly.
countrystring
languagestring
statusstring
active or paused.
metadatamap from strings to any
Arbitrary caller metadata.
createdAtstring

ISO-8601 creation timestamp.

runsinteger
How many times the monitor has run.
cronstring or null

Cron expression (overrides cadence when present).

modestringDefaults to diff
'diff' or 'snapshot'.
filter_promptstring or null

Natural-language predicate evaluated by Claude.

notify_onlist of strings

Subset of: change | match | error.

webhook_max_attemptsintegerDefaults to 3
webhook_backoff_secondsintegerDefaults to 30
webhook_secret_setbooleanDefaults to false

True if a webhook_secret is configured (the secret itself is never returned).

webhookstring or null
Where change events are delivered, if set.
lastRunAtstring or null

ISO-8601 timestamp of the most recent run.

nextRunAtstring or null

ISO-8601 timestamp of the next run, or null when paused.

last_webhook_statusinteger or null
HTTP status of the most recent webhook delivery, or null.
last_webhook_atdouble or null
Epoch seconds the last webhook delivery completed.
last_webhook_errorstring or null

Error message from the last webhook delivery, when it failed; null on success or when no webhook is set.

last_resultobject or null
Summary of the most recent monitor event, or null.

Errors

422
Unprocessable Entity Error