API resource
Visual Monitors
Visual Monitors watch selected site pages with baseline screenshots and scheduled visual checks. Use Visual Monitors to list, inspect, create, update, enable, disable, delete, and refresh visual-monitor configuration across sites available to your account.
List visual monitors
Lists visual monitors across sites available to the authenticated account, with optional filtering, sorting, and pagination. `page` values below `1` are treated as `1`; `perPage=0` is accepted as `perPage=1`; `perPage` values above `100` are capped to `100`.
/monitoring/visual-monitors POSTCreate visual monitor
Creates an enabled visual monitor for one site available to the authenticated account. Captures and stores a reference screenshot from `url` for the selected `device` before creating the monitor and returning 201. No reference image input is required. Capture failure returns 422 without creating a monitor. Success schedules the monitor's next check immediately.
/monitoring/visual-monitors GETShow visual monitor
Shows one visual monitor available to the authenticated account, including current configuration and recent visual-check snapshots.
/monitoring/visual-monitors/{visual_monitor_id} POSTUpdate visual monitor
Updates supplied visual monitor configuration fields. Omitted fields remain unchanged, and a valid request that changes nothing returns the current visual monitor without mutation effects. When `refresh_reference_image` is true, captures a new reference screenshot using the stored page URL and device before applying any updates. The request waits for capture and update completion. Capture failure returns 422 and leaves all monitor settings unchanged.
/monitoring/visual-monitors/{visual_monitor_id}/update POSTDelete visual monitors
Soft-deletes selected visual monitors available to the authenticated account and returns immediate item results.
/monitoring/visual-monitors/delete POSTEnable visual monitors
Enables selected visual monitors available to the authenticated account and returns immediate item results. Already-enabled monitors are successful no-op items.
/monitoring/visual-monitors/enable POSTDisable visual monitors
Disables selected visual monitors available to the authenticated account and returns immediate item results. Already-disabled monitors are successful no-op items.
/monitoring/visual-monitors/disable POSTRefresh visual monitors
Schedules selected visual monitors to be checked as soon as possible and returns immediate item results. Monitors must be enabled and have visual monitoring plan access. Disabled monitors return `monitor_not_enabled` without changing their schedule or status; eligible monitors in the same batch continue. The operation does not return check results.
/monitoring/visual-monitors/refresh GETList visual monitor probes
Lists current-month visual probe history for one accessible Visual Monitor.
/monitoring/visual-monitors/{visual_monitor_id}/probes