Save a view of a site's figures, under a name

Save a view of a site's figures, under a name.

# Save a view of a site's figures, under a name

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/post-sites-site-views

`POST /api/v1/sites/{site}/views`

Save a view of a site's figures, under a name.

## Parameters

- `site` (in path, needed): The site's id or name

## What to send

`SavedViewCreate`

- `name` (string, needed)
- `page` (string)
- `query` (string, needed)

## The answer

201, `SavedView`: A set of filters under a name (FI-03): the query string of the view, exactly as the address bar has it.

- `by` (string, needed)
- `id` (string, needed)
- `name` (string, needed)
- `page` (string, needed): The page it was saved on: `sources`, `pages`, or empty for the overview.
- `query` (string, needed)

## Asking

```sh
curl -X POST https://tidekeeper.eu/api/v1/sites/example.org/views \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "…", "query": "…"}'
```

Parameters

sitein the address

neededThe site's id or name

What to send

SavedViewCreate

name

stringneeded

page

string

query

stringneeded

The answer

Status 201

SavedView A set of filters under a name (FI-03): the query string of the view, exactly as the address bar has it.

by

stringneeded

id

stringneeded

name

stringneeded

page

stringneededThe page it was saved on: `sources`, `pages`, or empty for the overview.

query

stringneeded

Asking

curl -X POST https://tidekeeper.eu/api/v1/sites/example.org/views \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "…", "query": "…"}'

const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/views", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"name": "…", "query": "…"}),
}).then((r) => r.json());