Every site at a glance

This page as Markdown, or in an AI chatMore ways to read this page

Every site of the account, with its visitors, its trend and whether hits are arriving.

# Every site at a glance

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-overview

`GET /api/v1/overview`

Every site of the account, with its visitors, its trend and whether hits are arriving.

## Parameters

- `period` (in query): `7d` when left out

## The answer

200, `Overview`

- `account` (string): The workspace's name, for the list that has no site yet.
- `all_views` (number or null)
- `all_visitors` (number or null): Every site added up (SI-07). Daily visitors of each site, summed: someone who read two of them is counted by each.
- `archived` (integer): How many sites are put away and not in the list.
- `period` (PeriodView, needed)
- `sites` (list of SiteOverview, needed)

## Asking

```sh
curl -G https://tidekeeper.eu/api/v1/overview \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -d period=7d
```

Parameters

periodin the query: `7d` when left out

The answer

Status 200

Overview

account: stringThe workspace's name, for the list that has no site yet.
all_views: number or null
all_visitors: number or nullEvery site added up (SI-07). Daily visitors of each site, summed: someone who read two of them is counted by each.
archived: integerHow many sites are put away and not in the list.
period: PeriodViewneeded
sites: list of SiteOverviewneeded

Asking

curlJavaScript

With your token from Settings

curl -G https://tidekeeper.eu/api/v1/overview \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -d period=7d

With your token from Settings

const answer = await fetch("https://tidekeeper.eu/api/v1/overview?period=7d", {
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
  },
}).then((r) => r.json());