Documentation · API reference
PUT
/api/v1/sites/{site}/reportsPut site
This page as Markdown, or in an AI chatMore ways to read this page
# Put site
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/put-sites-site-reports
`PUT /api/v1/sites/{site}/reports`
## Parameters
- `site` (in path, needed): The site's id or name
## What to send
`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)
## 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 -X PUT https://tidekeeper.eu/api/v1/sites/example.org/reports \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"every": "…"}'
```
Parameters
- sitein the address
- neededThe site's id or name
What to send
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
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 -X PUT https://tidekeeper.eu/api/v1/sites/example.org/reports \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \ -H "Content-Type: application/json" \ -d '{"every": "…"}'
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/reports", { method: "PUT", headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({"every": "…"}), }).then((r) => r.json());