Documentation · API reference
GET
/api/v1/sites/{site}/visitorsVisitors who agreed, last seen first
This page as Markdown, or in an AI chatMore ways to read this page
Visitors who agreed, last seen first.
# Visitors who agreed, last seen first
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-visitors
`GET /api/v1/sites/{site}/visitors`
Visitors who agreed, last seen first.
## Parameters
- `site` (in path, needed): A site's id or name
- `period` (in query): 30d when left out
- `min_visits` (in query): Only visitors with this many visits
- `find` (in query): A visitor ID or the site's own user ID
- `limit` (in query): 25 when left out
- `offset` (in query): How many to skip
## The answer
200, `VisitorsResponse`
- `came_back` (integer, needed)
- `coverage` (Coverage, needed)
- `days_between` (number or null): Median days between one visit and the next.
- `keep_days` (integer, needed): How long a visitor is remembered: the site's setting.
- `period` (PeriodView, needed)
- `rows` (list of VisitorRow, needed)
- `signed_in` (integer, needed)
- `site` (string, needed)
- `total` (integer, needed): How many match in all.
- `visits_mean` (number or null)
- `visits_median` (number or null)
- `weeks` (list of WeekCount, needed)
## Asking
```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/visitors \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
Parameters
- sitein the address
- neededA site's id or name
- periodin the query
- 30d when left out
- min_visitsin the query
- Only visitors with this many visits
- findin the query
- A visitor ID or the site's own user ID
- limitin the query
- 25 when left out
- offsetin the query
- How many to skip
The answer
Status 200
VisitorsResponse
- came_back
- integerneeded
- coverage
- Coverageneeded
- days_between
- number or nullMedian days between one visit and the next.
- keep_days
- integerneededHow long a visitor is remembered: the site's setting.
- period
- PeriodViewneeded
- rows
- list of VisitorRowneeded
- signed_in
- integerneeded
- site
- stringneeded
- total
- integerneededHow many match in all.
- visits_mean
- number or null
- visits_median
- number or null
- weeks
- list of WeekCountneeded
Asking
curl https://tidekeeper.eu/api/v1/sites/example.org/visitors \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/visitors", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());