The page overlay

The page overlay: a stored copy of a page with the clicks each thing on it got, and how far down readers got.

# The page overlay

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-overlay

`GET /api/v1/sites/{site}/overlay`

The page overlay: a stored copy of a page with the clicks each thing on it got, and how far down readers got.

## Parameters

- `site` (in path, needed): A site's id or name
- `path` (in path, needed): The page: `/install`.
- `device` (in path, needed): `desktop` or `phone`.
- `period` (in path, needed)
- `show` (in path, needed): `clicks` or `depth`.
- `el` (in path, needed): The thing on the page that is selected, by its number.

## The answer

200, `OverlayView`: The page overlay (AE-07, AE-08, ME-07): a stored copy of a page, the clicks each thing on it got, and how far down readers got.

- `available` (boolean, needed): This tidekeeper has somewhere to show a copy.
- `copy` (SnapshotView or null)
- `depth` (list of OverlayDepth, needed): How many readers reached each quarter of the page's height.
- `depth_on` (boolean, needed): The site's pages say how far down they were read.
- `depth_views` (integer, needed): How many views said how far down they were read.
- `device` (string, needed)
- `frame` (FrameAt or null)
- `links` (list of OverlayLink, needed): Everything on the page with a count, most clicked first.
- `links_on` (boolean, needed): The site counts clicks on its own links.
- `path` (string, needed)
- `period` (PeriodView or null)
- `reason` (string, needed)
- `selected` (integer or null)
- `show` (string, needed)
- `site` (string, needed)
- `views` (integer, needed): Views of the page in the period.

## Asking

```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/overlay \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```

Parameters

sitein the address

neededA site's id or name

pathin the address

neededThe page: `/install`.

devicein the address

needed`desktop` or `phone`.

periodin the address

needed

showin the address

needed`clicks` or `depth`.

elin the address

neededThe thing on the page that is selected, by its number.

The answer

Status 200

OverlayView The page overlay (AE-07, AE-08, ME-07): a stored copy of a page, the clicks each thing on it got, and how far down readers got.

available

booleanneededThis tidekeeper has somewhere to show a copy.

copy

SnapshotView or null

depth

list of OverlayDepthneededHow many readers reached each quarter of the page's height.

depth_on

booleanneededThe site's pages say how far down they were read.

depth_views

integerneededHow many views said how far down they were read.

device

stringneeded

frame

FrameAt or null

links

list of OverlayLinkneededEverything on the page with a count, most clicked first.

links_on

booleanneededThe site counts clicks on its own links.

path

stringneeded

period

PeriodView or null

reason

stringneeded

selected

integer or null

show

stringneeded

site

stringneeded

views

integerneededViews of the page in the period.

Asking

curl https://tidekeeper.eu/api/v1/sites/example.org/overlay \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"

const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/overlay", {
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
  },
}).then((r) => r.json());