A breakdown across the sites

A dimension added up over the sites, each row split by site.

# A breakdown across the sites

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

`GET /api/v1/across`

A dimension added up over the sites, each row split by site.

## Parameters

- `period` (in path, needed): The period, as everywhere: `7d` when left out.
- `in` (in path, needed): `easy`, `hard` or a group's id; every site when left out.
- `dim` (in path, needed): The dimension: `page`, `entry`, `exit`, `source`, `channel`, `utm_campaign`, `country`, `device`, `browser`, `os`, …
- `limit` (in path, needed): Rows at most: 50 when left out, 200 at the most.

## The answer

200, `AcrossView`: A dimension added up over the sites in a scope (doc/all-sites.md §3.4).

- `dim` (string, needed)
- `period` (PeriodView, needed)
- `rows` (list of AcrossRow, needed)
- `scope` (SitesScope, needed)
- `sites` (list of AcrossSite, needed)

## Asking

```sh
curl https://tidekeeper.eu/api/v1/across \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```

Parameters

periodin the address

neededThe period, as everywhere: 7d when left out.

inin the address

needed easy, hard or a group's id; every site when left out.

dimin the address

neededThe dimension: page, entry, exit, source, channel, utm_campaign, country, device, browser, os, …

limitin the address

neededRows at most: 50 when left out, 200 at the most.

The answer

Status 200

AcrossView A dimension added up over the sites in a scope (doc/all-sites.md §3.4).

dim

stringneeded

period

PeriodViewneeded

rows

list of AcrossRowneeded

scope

SitesScopeneeded

sites

list of AcrossSiteneeded

Asking

curl https://tidekeeper.eu/api/v1/across \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"

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