Sign in
website

List Website Snapshots

Snapshot version history, newest first.

get/api/v1/website/properties/{property_id}/snapshots

Path parameters

property_idstring uuid required

Query parameters

limitinteger

Response

Successful Response

idstring uuid required
property_idstring uuid required
base_urlstring required
registrable_domainstring required
status'queued' | 'discovering' | 'capturing' | 'completed' | 'failed' required

Lifecycle of a website capture run (see WebsiteSnapshot).

A real capture (discovery + rendering up to 60 pages in a browser) takes minutes, so the work runs on the arq worker and callers poll this status. QUEUED → DISCOVERING → CAPTURING → COMPLETED, or → FAILED at any point with a human-readable error_message.

pages_discoveredinteger required
pages_capturedinteger required
error_messagestring nullable required
started_atstring date-time nullable required
completed_atstring date-time nullable required

Changes