Documentation · API reference
GET/api/v1/sites/{site}/visitors

Visitors who agreed, last seen first

Visitors who agreed, last seen first.

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

With your token from Settings
curl https://tidekeeper.eu/api/v1/sites/example.org/visitors \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
With your token from Settings
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/visitors", {
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
  },
}).then((r) => r.json());