Documentation · API reference
GET
/api/v1/sites/{site}/reportsWhat a site's report by email is set to
This page as Markdown, or in an AI chatMore ways to read this page
What a site's report by email is set to.
# What a site's report by email is set to
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-reports
`GET /api/v1/sites/{site}/reports`
What a site's report by email is set to.
## Parameters
- `site` (in path, needed): The site's id or name
## The answer
200, `ReportSetting`: Who is sent a site's report, or the digest of every site, and how often.
- `every` (string, needed): `off`, `weekly` or `monthly`.
- `sends` (string): When it goes out, in words. Set by the server.
- `to` (list of string)
## Asking
```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/reports \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
Parameters
- sitein the address
- neededThe site's id or name
The answer
Status 200
ReportSetting Who is sent a site's report, or the digest of every site, and how often.
- every
- stringneeded`off`, `weekly` or `monthly`.
- sends
- stringWhen it goes out, in words. Set by the server.
- to
- list of string
Asking
curl https://tidekeeper.eu/api/v1/sites/example.org/reports \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/reports", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());