Who signed up, what needs someone, and what comes in

Who signed up, what needs someone, and what comes in. Operators only.

# Who signed up, what needs someone, and what comes in

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-admin-overview

`GET /api/v1/admin/overview`

Who signed up, what needs someone, and what comes in. Operators only.

## The answer

200, `AdminOverview`

- `accounts` (integer, needed)
- `approval` (boolean): New accounts wait for an operator's approval here.
- `funnel` (list of Stage, needed): The same accounts as a funnel, with those who never confirmed on top.
- `money` (Money, needed)
- `needs` (list of Needs, needed)
- `now` (integer, needed)
- `provider` (string, needed): Whether a provider that takes payment is connected, and its name.
- `signups` (list of SignupDay, needed): The last thirty days, newest first. Days nobody signed up on are left out.
- `stray` (list of StrayEvent, needed)
- `test_mode` (boolean): It takes no real payment: its keys are test keys.
- `unconfirmed` (list of Unconfirmed, needed)

## Asking

```sh
curl https://tidekeeper.eu/api/v1/admin/overview \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```

The answer

Status 200

AdminOverview

accounts

integerneeded

approval

booleanNew accounts wait for an operator's approval here.

funnel

list of StageneededThe same accounts as a funnel, with those who never confirmed on top.

money

Moneyneeded

needs

list of Needsneeded

now

integerneeded

provider

stringneededWhether a provider that takes payment is connected, and its name.

signups

list of SignupDayneededThe last thirty days, newest first. Days nobody signed up on are left out.

stray

list of StrayEventneeded

test_mode

booleanIt takes no real payment: its keys are test keys.

unconfirmed

list of Unconfirmedneeded

Asking

curl https://tidekeeper.eu/api/v1/admin/overview \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"

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