Skip to content
Tò He Docs

Accounts, players, rooms, errors, the catalog and the outbox at a glance.

GET
/api/admin/overview
curl --request GET \
  --url https://example.com/api/admin/overview

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
at
required
string format: date-time
version
required
string
accounts
required
object
total
required
integer format: int32
lastDay
required
integer format: int32
lastWeek
required
integer format: int32
profiles
required
object
total
required
integer format: int32
lastDay
required
integer format: int32
lastWeek
required
integer format: int32
players
required
object
lastDay
required
integer format: int32
lastWeek
required
integer format: int32
rooms
required
object
open
required
integer format: int32
playing
required
integer format: int32
online
required
integer format: int32
errorsLastDay
required
null | integer format: int32
catalog
required
object
listed
required
integer format: int32
unlisted
required
integer format: int32
lastSyncAt
required
null | string format: date-time
lastError
required
null | string
email
required
object
enabled
required
boolean
waiting
required
integer format: int32
sentLastDay
required
integer format: int32
failedLastDay
required
integer format: int32
oldestWaitingSince
required
null | string format: date-time
heldResults
required
integer format: int32
deletionsDue
required
integer format: int32

Example generated

{
  "at": "2026-04-15T12:00:00Z",
  "version": "example",
  "accounts": {
    "total": 1,
    "lastDay": 1,
    "lastWeek": 1
  },
  "profiles": {
    "total": 1,
    "lastDay": 1,
    "lastWeek": 1
  },
  "players": {
    "lastDay": 1,
    "lastWeek": 1
  },
  "rooms": {
    "open": 1,
    "playing": 1,
    "online": 1
  },
  "errorsLastDay": 1,
  "catalog": {
    "listed": 1,
    "unlisted": 1,
    "lastSyncAt": "2026-04-15T12:00:00Z",
    "lastError": "example"
  },
  "email": {
    "enabled": true,
    "waiting": 1,
    "sentLastDay": 1,
    "failedLastDay": 1,
    "oldestWaitingSince": "2026-04-15T12:00:00Z"
  },
  "heldResults": 1,
  "deletionsDue": 1
}