Documentation · API reference
GET
/api/v1/sites/{site}/holdsWhat deleting a site would take with it
This page as Markdown, or in an AI chatMore ways to read this page
What deleting a site would take with it: said before its name is typed.
# What deleting a site would take with it
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-holds
`GET /api/v1/sites/{site}/holds`
What deleting a site would take with it: said before its name is typed.
## Parameters
- `site` (in path, needed): A site's id or name
## The answer
200, `SiteHolds`: What deleting a site would take with it (the Dialogs board), said before anyone is asked to type its name.
- `copies_days` (integer or null): Copies of the database are kept this many days: that long after a deletion it is gone from every copy. None: not said for this instance.
- `first_day` (string or null): The first day there is a figure for, counted or brought in.
- `goals` (integer, needed)
- `imported` (boolean, needed): Days brought from another tool are among its totals.
- `links` (integer, needed): Private links that still open.
- `months` (integer, needed): How many months that is, to today.
- `notes` (integer, needed)
- `public` (boolean, needed): Its public dashboard is on.
- `rows` (integer, needed): Views and events tidekeeper counted itself, one row each.
- `site` (string, needed)
- `snapshots` (integer, needed): Stored copies of its pages.
## Asking
```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/holds \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
Parameters
- sitein the address
- neededA site's id or name
The answer
Status 200
SiteHolds What deleting a site would take with it (the Dialogs board), said before anyone is asked to type its name.
- copies_days
- integer or nullCopies of the database are kept this many days: that long after a deletion it is gone from every copy. None: not said for this instance.
- first_day
- string or nullThe first day there is a figure for, counted or brought in.
- goals
- integerneeded
- imported
- booleanneededDays brought from another tool are among its totals.
- links
- integerneededPrivate links that still open.
- months
- integerneededHow many months that is, to today.
- notes
- integerneeded
- public
- booleanneededIts public dashboard is on.
- rows
- integerneededViews and events tidekeeper counted itself, one row each.
- site
- stringneeded
- snapshots
- integerneededStored copies of its pages.
Asking
curl https://tidekeeper.eu/api/v1/sites/example.org/holds \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/holds", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());