The nightly check on a site's own page

The nightly check on a site's own page: with what its scan found among what that site's pages sent.

# The nightly check on a site's own page

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

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

The nightly check on a site's own page: with what its scan found among what that site's pages sent.

## Parameters

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

## The answer

200, `NightlyView`: The nightly check (the Stores board): what each check found the last time it ran here.

- `checks` (list of NightlyLine, needed)
- `next` (integer, needed): When it runs next.
- `of` (integer, needed)
- `passed` (integer, needed): Of the checks that run here, how many passed, and how many there are.
- `ran` (integer or null): When it last ran. None: not yet, on this tidekeeper.
- `version` (string, needed): The version that ran it.

## Asking

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

Parameters

sitein the address

neededA site's id or name

The answer

Status 200

NightlyView The nightly check (the Stores board): what each check found the last time it ran here.

checks

list of NightlyLineneeded

next

integerneededWhen it runs next.

of

integerneeded

passed

integerneededOf the checks that run here, how many passed, and how many there are.

ran

integer or nullWhen it last ran. None: not yet, on this tidekeeper.

version

stringneededThe version that ran it.

Asking

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

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