website

Get Website Snapshot

Changed on

Poll one snapshot: status, counters, error.

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

Request

  • Base URL: https://api.getanana.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.getanana.com/api/v1/website/properties/{property_id}/snapshots/{snapshot_id}
  • Auth: none declared

Path parameters

snapshot_idstring uuid required
property_idstring uuid required

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

  • d65b8fefae34Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status