Bots, across the sites

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

What bots read across the sites.

# Bots, across the sites

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

`GET /api/v1/across/bots`

What bots read across the sites.

## 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, `AcrossBots`: What bots read across the sites (doc/all-sites.md §3.4).

- `ai_reads` (integer, needed)
- `bots` (list of AcrossBot, needed)
- `period` (PeriodView, needed)
- `reads` (integer, needed)
- `scope` (SitesScope, needed)
- `site_reads` (list of integer, needed): Each site's reads, in the order of `sites`.
- `sites` (list of AcrossSite, needed)

## Asking

```sh
curl https://tidekeeper.eu/api/v1/across/bots \
    -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

AcrossBots What bots read across the sites (doc/all-sites.md §3.4).

ai_reads: integerneeded
bots: list of AcrossBotneeded
period: PeriodViewneeded
reads: integerneeded
scope: SitesScopeneeded
site_reads: list of integerneededEach site's reads, in the order of sites.
sites: list of AcrossSiteneeded

Asking

curlJavaScript

With your token from Settings

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

With your token from Settings

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