Monitors
API functions for the Monitors resource.
Monitors
Functions for interacting with the monitors API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.
First-capture behavior is the same for both monitor types: the first capture is a silent baseline (has_change=False, change_pct=None) with no change_detected webhook, whether the monitor is scrape or screenshot. From the second capture onward both types diff against the previous capture.
Create Monitor
Create a change-detection monitor
Creates a recurring change-detection monitor for a URL, delivering results via webhook.
Limits: request bodies are capped at 512 KB. An oversized body
returns a 400 with error code request_too_large.
Parameters
body (MonitorCreateRequest)
Call styles
sync_detailed(client=client, body=body) -> Response[Union[Error, MonitorCreateResponse]]
sync(client=client, body=body) -> Optional[Union[Error, MonitorCreateResponse]]
await asyncio_detailed(client=client, body=body) -> Response[Union[Error, MonitorCreateResponse]]
await asyncio(client=client, body=body) -> Optional[Union[Error, MonitorCreateResponse]]Delete Monitor
Cancel monitor
Parameters
id (str)
Call styles
sync_detailed(id=id, client=client) -> Response[Union[Any, Error]]
sync(id=id, client=client) -> Optional[Union[Any, Error]]
await asyncio_detailed(id=id, client=client) -> Response[Union[Any, Error]]
await asyncio(id=id, client=client) -> Optional[Union[Any, Error]]Get Monitor
Get monitor
Parameters
id (str)
Call styles
sync_detailed(id=id, client=client) -> Response[Union[Error, MonitorResponse]]
sync(id=id, client=client) -> Optional[Union[Error, MonitorResponse]]
await asyncio_detailed(id=id, client=client) -> Response[Union[Error, MonitorResponse]]
await asyncio(id=id, client=client) -> Optional[Union[Error, MonitorResponse]]List Monitor Captures
List monitor captures
Parameters
id (str)limit (Union[Unset, int])cursor (Union[Unset, str])
Call styles
sync_detailed(id=id, client=client, limit=limit, cursor=cursor) -> Response[ListMonitorCapturesResponse200]
sync(id=id, client=client, limit=limit, cursor=cursor) -> Optional[ListMonitorCapturesResponse200]
await asyncio_detailed(id=id, client=client, limit=limit, cursor=cursor) -> Response[ListMonitorCapturesResponse200]
await asyncio(id=id, client=client, limit=limit, cursor=cursor) -> Optional[ListMonitorCapturesResponse200]List Monitors
List monitors
Parameters
limit (Union[Unset, int])cursor (Union[Unset, str])status (Union[Unset, ListMonitorsStatus])
Call styles
sync_detailed(client=client, limit=limit, cursor=cursor, status=status) -> Response[ListMonitorsResponse200]
sync(client=client, limit=limit, cursor=cursor, status=status) -> Optional[ListMonitorsResponse200]
await asyncio_detailed(client=client, limit=limit, cursor=cursor, status=status) -> Response[ListMonitorsResponse200]
await asyncio(client=client, limit=limit, cursor=cursor, status=status) -> Optional[ListMonitorsResponse200]Update Monitor
Update monitor
Parameters
id (str)body (MonitorUpdateRequest)
Call styles
sync_detailed(id=id, client=client, body=body) -> Response[Union[Error, MonitorResponse]]
sync(id=id, client=client, body=body) -> Optional[Union[Error, MonitorResponse]]
await asyncio_detailed(id=id, client=client, body=body) -> Response[Union[Error, MonitorResponse]]
await asyncio(id=id, client=client, body=body) -> Optional[Union[Error, MonitorResponse]]