The banner

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

The banner: what is live, the draft, and every version that was shown.

# The banner

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

`GET /api/v1/sites/{site}/banner`

The banner: what is live, the draft, and every version that was shown.

## Parameters

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

## The answer

200, `BannersView`

- `draft` (BannerView or null)
- `live` (BannerView or null)
- `own_tool` (boolean, needed): The site asks with its own tool: no banner of ours is shown.
- `site` (string, needed)
- `starting` (object, needed): What a new draft starts from.
- `versions` (list of BannerView, needed): Every version that was shown, newest first (CR-03).

## Asking

```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/banner \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```

Parameters

sitein the address: neededA site's id or name

The answer

Status 200

BannersView

draft: BannerView or null
live: BannerView or null
own_tool: booleanneededThe site asks with its own tool: no banner of ours is shown.
site: stringneeded
starting: objectneededWhat a new draft starts from.
versions: list of BannerViewneededEvery version that was shown, newest first (CR-03).

Asking

curlJavaScript

With your token from Settings

curl https://tidekeeper.eu/api/v1/sites/example.org/banner \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"

With your token from Settings

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