Monitor API
Get a run
Retrieve one Monitor run, including its state, counts, changes, and target errors.
GET
A run is available as soon as Run a monitor now returns it. Read
status to check its progress, changes for findings, and target_errors for Page targets that could not be read.
Every run includes usage.searches, usage.fetched_urls, and an estimated usage.cost, with total_cost and currency (USD). Usage and cost are zero unless the run succeeds. See Monitor API pricing for rates.
A failed run’s error has code and message; a skipped run has skip_reason and message. Use the typed code or reason rather than parsing message text.
Each Page target error has type, url, code, and message. An error with code http_status also includes status_code; other codes distinguish blocked pages, missing content, timeouts, and fetch failures. Allow for new codes.
Read changes
- Search results:
changes[].typeissearch_result. A result can include a title, snippet,published_at, andlast_updated_at; unavailable fields are omitted rather than set tonull. - Page changes:
changes[].typeispage_change. Thediffcontains unified text, added and removed line counts, and atruncatedflag. Line counts cover the full diff even when the unified text is truncated. - Change IDs:
changes[].idstays the same wherever the same finding is reported. Use it to deduplicate findings across runs and webhooks, and skip change types you do not recognize.
last_updated_at is the source’s last-updated date, at calendar-day precision, not the exact time its content changed. published_at is its publication date; selecting updated freshness does not make URLs already reported by this monitor eligible again. finished_at is omitted until the run ends, and window is omitted while it is queued.
Authorizations
Path Parameters
Response
The run