SDK ReferencePython SDK
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
Parameters
body (MonitorCreateRequest)
Call styles
sync_detailed(client=client, body=body) -> Response[Error | MonitorResponse]
sync(client=client, body=body) -> Error | MonitorResponse | None
await asyncio_detailed(client=client, body=body) -> Response[Error | MonitorResponse]
await asyncio(client=client, body=body) -> Error | MonitorResponse | NoneDelete Monitor
Cancel monitor
Parameters
id (str)
Call styles
sync_detailed(id=id, client=client) -> Response[Any | Error]
sync(id=id, client=client) -> Any | Error | None
await asyncio_detailed(id=id, client=client) -> Response[Any | Error]
await asyncio(id=id, client=client) -> Any | Error | NoneGet Monitor
Get monitor
Parameters
id (str)
Call styles
sync_detailed(id=id, client=client) -> Response[Error | MonitorResponse]
sync(id=id, client=client) -> Error | MonitorResponse | None
await asyncio_detailed(id=id, client=client) -> Response[Error | MonitorResponse]
await asyncio(id=id, client=client) -> Error | MonitorResponse | NoneList Monitor Captures
List monitor captures
Parameters
id (str)limit (int | Unset): Default: 25.cursor (str | Unset)
Call styles
sync_detailed(id=id, client=client, limit=limit, cursor=cursor) -> Response[ListMonitorCapturesResponse200]
sync(id=id, client=client, limit=limit, cursor=cursor) -> ListMonitorCapturesResponse200 | None
await asyncio_detailed(id=id, client=client, limit=limit, cursor=cursor) -> Response[ListMonitorCapturesResponse200]
await asyncio(id=id, client=client, limit=limit, cursor=cursor) -> ListMonitorCapturesResponse200 | NoneList Monitors
List monitors
Parameters
limit (int | Unset): Default: 25.cursor (str | Unset)status (ListMonitorsStatus | Unset): Default: ListMonitorsStatus.ACTIVE.
Call styles
sync_detailed(client=client, limit=limit, cursor=cursor, status=status) -> Response[ListMonitorsResponse200]
sync(client=client, limit=limit, cursor=cursor, status=status) -> ListMonitorsResponse200 | None
await asyncio_detailed(client=client, limit=limit, cursor=cursor, status=status) -> Response[ListMonitorsResponse200]
await asyncio(client=client, limit=limit, cursor=cursor, status=status) -> ListMonitorsResponse200 | NoneUpdate Monitor
Update monitor
Parameters
id (str)body (MonitorUpdateRequest)
Call styles
sync_detailed(id=id, client=client, body=body) -> Response[Error | MonitorResponse]
sync(id=id, client=client, body=body) -> Error | MonitorResponse | None
await asyncio_detailed(id=id, client=client, body=body) -> Response[Error | MonitorResponse]
await asyncio(id=id, client=client, body=body) -> Error | MonitorResponse | None