Base URL
X-API-Key header. See Authentication.
Endpoints
Create a Monitor
- Page
- Topic
201 Created and contains the new Monitor plus its first baseline run:
purpose or dashboard-managed email settings.
Common Fields
A five-field cron expression. It runs in UTC unless prefixed with an IANA time zone, for example
CRON_TZ=America/New_York 0 9 * * 1-5. Topic schedules must keep every run at least 30 minutes
apart.Optional description of the change that matters, up to 2000 characters. TinyFish evaluates
detected changes against this purpose.
Email delivery is currently configured in the dashboard. The REST API does not accept email
settings.
Page Config
CSS selectors (1-20) that scope each run to matching elements, so the Monitor only reports
changes inside them, for example
[".price"]. Works like Fetch’s
include_selectors. If no selector matches when you create the
Monitor, the request fails with 422, lists selectors found on the page, and no Monitor is
created. If a later run
matches nothing, that run fails with selector_not_matched.CSS selectors (1-20) for elements to remove before comparing, such as ads, timestamps, or
rotating banners.
ttl: 0 to prefer fresh content. The deprecated config.ttl
field is accepted for compatibility but does not change this behavior.
Topic Config
List and Get Monitors
monitors array. To retrieve one Monitor:
Pause or Resume
Send a status-only update.active resumes the schedule and paused stops future scheduled runs
without removing history.
Edit a Monitor
Send only the fields you want to change:schedule_cron, name, purpose, or webhook_url.
Omitted fields keep their existing values, and null clears the name, purpose, or webhook URL.
Send at least one field.
update methods still take schedule_cron. To change several fields at once:
config cannot be changed after creation. Create a new Monitor to watch a
different page or topic.
Run Now
201 Created with the Page Fetch result or Topic Search result under run. Run now
works for active, paused, and failed Monitors.
A Topic Monitor run can return 409 Conflict with error.code set to RETRY_REQUIRED when the run
could not be created. Retry the request.
Run now records the result but does not send webhook or email notifications. Those delivery paths
run only for scheduled checks.
Delete a Monitor
Scheduled Webhook Payloads
Webhooks are sent for every scheduled run, including runs with no changes. Page payloads include afetch_monitor_id; Topic payloads include a search_monitor_id.
- Page
- Topic
outcomeischangedorunchangedcompared with the previous run. It isbaselinewhen there is no previous run to compare with, such as the first run.diffis a unified diff against the previous run. It isnullforbaselineandunchangedruns.diff_truncatedistruewhen the diff was cut at a line to keep the payload under 1 MB. Open the run in the dashboard for the full diff.judgmentchecks the change against the Monitor’s purpose. It isnullforbaselineandunchangedruns, and when the Monitor has no purpose.summaryis set only whenis_relevantistrue. When the check fails,is_relevantisnullanderroris set.resultsholds the full page content for every run.