Sign in
website

Start Website Snapshot Route

Kick off a website capture; returns a snapshot to poll.

Idempotent while a capture is running: a second kickoff returns the running snapshot. Verification is a hard 422 — the URL (given or stored) must match the property's verified website, and a property with no verified website is refused with the fix named (Locked Decision 4).

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

Path parameters

property_idstring uuid required

Request body

urlstring nullable

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