Documentation · API reference
GET
/api/v1/sites/{site}/snapshots/frameWhere a copy of a page can be shown for the next hour
This page as Markdown, or in an AI chatMore ways to read this page
Where a copy of a page can be shown for the next hour: an address on the other origin, for a frame.
# Where a copy of a page can be shown for the next hour
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-snapshots-frame
`GET /api/v1/sites/{site}/snapshots/frame`
Where a copy of a page can be shown for the next hour: an address on the other origin, for a frame.
## Parameters
- `site` (in path, needed): A site's id or name
- `path` (in query, needed): The page's path
- `device` (in query): `desktop` or `phone`
## The answer
200, `SnapshotFrame`: Where a copy can be shown for the next hour.
- `copy` (SnapshotView, needed)
- `expires` (integer, needed)
- `url` (string, needed): An address on the other origin, for a frame.
- `width` (integer, needed): How wide the frame is for this device, in pixels.
## Asking
```sh
curl -G https://tidekeeper.eu/api/v1/sites/example.org/snapshots/frame \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
-d path=…
```
Parameters
- sitein the address
- neededA site's id or name
- pathin the query
- neededThe page's path
- devicein the query
- `desktop` or `phone`
The answer
Status 200
SnapshotFrame Where a copy can be shown for the next hour.
- copy
- SnapshotViewneeded
- expires
- integerneeded
- url
- stringneededAn address on the other origin, for a frame.
- width
- integerneededHow wide the frame is for this device, in pixels.
Asking
curl -G https://tidekeeper.eu/api/v1/sites/example.org/snapshots/frame \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \ -d path=…
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/snapshots/frame?path=…", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());