admin

The whole service at a glance. Owner only.

Counts across every account: accounts and people; runs (total, last 24 hours, last 7 days, failed in the last 24 hours, in flight); hooks; credits charged (last 24 hours, 7 days, ever) and every balance summed; access requests pending, usable codes and redemptions; the search provider's credits_left, low and accepting_runs (null when not read yet); and the running commit. Needs the admin scope and an admin account. MCP: admin_overview.

get/v1/admin/overview

Request

Base URL: https://api.hookdetector.com (the document declares no server; this is the origin it was published from)
URL: https://api.hookdetector.com/v1/admin/overview
Auth: none declared

Headers

authorizationstring nullable

Bearer hd_... from POST /v1/accounts or POST /v1/keys

Response

Successful Response

accountsinteger required

usersinteger required

commitstring required

Example response

{
  "access": {
    "active_codes": 5,
    "pending_requests": 3,
    "redemptions": 14
  },
  "accounts": 42,
  "commit": "5d3194d0c1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6",
  "credits": {
    "balance_total": 9300,
    "charged_24h": 610,
    "charged_7d": 4100,
    "charged_total": 18000
  },
  "hooks": {
    "last_24h": 96,
    "total": 2400
  },
  "runs": {
    "failed_24h": 1,
    "in_flight": 2,
    "last_24h": 12,
    "last_7d": 80,
    "total": 310
  },
  "search": {
    "accepting_runs": true,
    "credits_left": 5200,
    "low": false
  },
  "users": 17
}

Changes

No recorded changes to this operation across all 1 revision of this API.