Sign in
website

List Website Sites

One row per property: latest completed capture summary, any active capture status, and a presigned homepage-screenshot thumbnail.

The homepage is deterministic: among the latest completed snapshot's pages with a screenshot and no capture error, the shortest path (tie-break: lexicographic) — the capture's entry page.

get/api/v1/website/sites

Response

Successful Response

property_idstring uuid required
property_namestring required
website_urlstring nullable required
base_urlstring nullable required
registrable_domainstring nullable required
pages_capturedinteger nullable required
pages_failedinteger nullable required
pages_discoveredinteger nullable required
last_captured_atstring date-time nullable required
thumbnail_urlstring nullable required
active_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.

Changes

Changed in 1 of the 6 revisions of this API.1