---
title: "A snapshot with its page list (once ready) and the caller’s own compares that use it; the same document the web app shows. Authorized by the account’s key or by a share token its owner issued. Free."
method: GET
path: "/snapshots/{id}"
---

# A snapshot with its page list (once ready) and the caller’s own compares that use it; the same document the web app shows. Authorized by the account’s key or by a share token its owner issued. Free.

`GET /snapshots/{id}`

## Request

- Base URL: `https://app.difficat.com/api/v1`
- URL: `https://app.difficat.com/api/v1/snapshots/{id}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

OK

- SnapshotDetail
  - `snapshot` Snapshot, required
    - `id` string, required
    - `label` string, required
    - `origin` string, uri, required: The captured site’s origin; it is never fetched by a compare.
    - `viewportWidth` integer, required
    - `checkMode` 'full' | 'text-only' | 'existence-only', required
    - `pageCount` integer, required
    - `errorPages` integer: Pages that answered with an error status or were unreachable.
    - `status` 'capturing' | 'ready', required
    - `via` 'capture' | 'run'
    - `createdAt` integer, required: Epoch ms.
    - `updatedAt` integer, required: Epoch ms.
    - `completedAt` integer: Epoch ms.
    - `access` 'owner' | 'reader', required: The caller’s role on the snapshot.
  - `pages` object[], required: Empty until the snapshot is ready.
    - `n` integer, required
    - `path` string, required
    - `status` integer: The HTTP status the page answered with; 0 when unreachable.
    - `screenshot` boolean: Whether a screenshot was stored.
  - `compares` object[], required: The caller’s own compares that use the snapshot.
    - `id` string, required
    - `snapshotAId` string, required
    - `snapshotBId` string, required
    - `status` 'running' | 'ready', required
    - `via` 'snapshots' | 'run', required
    - `createdAt` integer, required: Epoch ms.
    - `saved` boolean, required: Kept until deleted (created by a Pro account); otherwise removed 30 days after creation.
    - `summary` object
      - `totalPages` integer, required
      - `passed` integer, required
      - `failed` integer, required
    - `threshold` number
  - `sharedCompareCount` integer: Owner only: compares others saved against it.

## Other responses

- `401`: No Authorization header at all (credential_required)
- `404`: No such snapshot, or the credential has no access to it: a key whose account is neither owner nor reader, a token for another snapshot, a revoked or expired grant, an anonymous or lapsed key
- `429`: More than 1,000 reads this hour for this key or token (Retry-After)
- `500`: A stored file failed validation (snapshot_unreadable)
- `503`: Snapshots are not available on this deployment

---

[API](https://skmtc.dev/difficat/apis/difficat-agent-api.md) · [All operations](https://skmtc.dev/difficat/apis/difficat-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/difficat/apis/difficat-agent-api/revisions/49c291e77659?raw)