What came before and after a page or an event

What came before and after a page or an event.

# What came before and after a page or an event

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

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

What came before and after a page or an event.

## Parameters

- `site` (in path, needed): A site's id or name
- `from` (in query): page:/a/path or event:a name
- `reach` (in query): visit or visitor
- `steps` (in query): 1 to 3
- `period` (in query): 30d when left out

## The answer

200, `PathsReport`

- `after` (list of PathRow, needed)
- `before` (list of PathRow, needed)
- `choices` (list of string, needed): Things paths can start from: the site's busiest pages and events.
- `coverage` (Coverage, needed)
- `from` (string, needed): What the paths start from, in words.
- `period` (PeriodView, needed)
- `reach` (string, needed): `visit` or `visitor`.
- `routes` (list of RouteRow, needed): The commonest whole routes to it.
- `site` (string, needed)
- `steps` (integer, needed)
- `visitors` (integer, needed): Visitors who did it in the period.

## Asking

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

Parameters

sitein the address

neededA site's id or name

fromin the query

page:/a/path or event:a name

reachin the query

visit or visitor

stepsin the query

1 to 3

periodin the query

30d when left out

The answer

Status 200

PathsReport

after

list of PathRowneeded

before

list of PathRowneeded

choices

list of stringneededThings paths can start from: the site's busiest pages and events.

coverage

Coverageneeded

from

stringneededWhat the paths start from, in words.

period

PeriodViewneeded

reach

stringneeded`visit` or `visitor`.

routes

list of RouteRowneededThe commonest whole routes to it.

site

stringneeded

steps

integerneeded

visitors

integerneededVisitors who did it in the period.

Asking

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

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