ApiUsageSummary

API traffic for Admin → API usage: totals, the busiest keys, collectors and operations, blocks, and the limits in force.

object

Fields

sincestring (date)required
The first day counted (UTC).
daysintegerrequired
totalsobjectrequired
ShowHide the fields of totals
- requestsintegerrequired
- limitedintegerrequired
- errors4xxintegerrequired
- errors5xxintegerrequired
dailyarray of objectrequired
ShowHide the fields of daily
- daystring (date)required
- requestsintegerrequired
- limitedintegerrequired
  Requests refused by a rate limit (429).
- errorsintegerrequired
  Answers with a 4xx (other than our 429s) or a 5xx.
keysarray of objectrequired
The busiest API keys (top 25).
ShowHide the fields of keys
- subjectstringrequired
- keyIdstring (uuid)required
- namestring or nullrequired
- prefixstring or nullrequired
- kindenum or nullrequired
  One ofpersonalstoreadmin
- ownerobject or nullrequired
  ShowHide the fields of owner
  idstring (uuid)required
  labelstring or nullrequired
- requestsintegerrequired
- limitedintegerrequired
- errors4xxintegerrequired
- errors5xxintegerrequired
- lastDaystring (date)required
usersarray of objectrequired
The busiest signed-in collectors in our apps (top 25).
ShowHide the fields of users
- subjectstringrequired
- userIdstring (uuid)required
- labelstring or nullrequired
- requestsintegerrequired
- limitedintegerrequired
- errors4xxintegerrequired
- errors5xxintegerrequired
- lastDaystring (date)required
anonymousobjectrequired
Signed-out callers, counted together (no network addresses are kept).
ShowHide the fields of anonymous
- requestsintegerrequired
- limitedintegerrequired
routesarray of objectrequired
The busiest operations (top 25).
ShowHide the fields of routes
- routestringrequired
- requestsintegerrequired
- limitedintegerrequired
- errors4xxintegerrequired
- errors5xxintegerrequired
blocksarray of objectrequired
Callers blocked right now.
ShowHide the fields of blocks
- subjectstringrequired
  key:<id>, user:<id> or ip:<address> (a network guessing keys).
- labelstring or nullrequired
- blockedUntilstring (date-time)required
- levelintegerrequired
  How many times in a row: each block doubles.
- reasonstringrequired
- blockedAtstring (date-time)required
tiersarray of objectrequired
ShowHide the fields of tiers
- tierenumrequired
  One ofanonymousappfreepaidstoreadmin
- perMinuteintegerrequired
- perDayinteger or nullrequired
- descriptionstringrequired
quotasarray of objectrequired
ShowHide the fields of quotas
- bucketstringrequired
- perDayintegerrequired
- descriptionstringrequired
settingsobjectrequired
ShowHide the fields of settings
- personalKeysRequirePaidbooleanrequired
- blockThresholdintegerrequired
- blockWindowMinutesintegerrequired
- blockMinutesintegerrequired
- blockMaxMinutesintegerrequired

Used by

GETAPI usage

ApiUsageSummary · example shape

{
  "since": "2026-10-11",
  "days": 0,
  "totals": {
    "requests": 0,
    "limited": 0,
    "errors4xx": 0,
    "errors5xx": 0
  },
  "daily": [
    {
      "day": "2026-10-11",
      "requests": 0,
      "limited": 0,
      "errors": 0
    }
  ],
  "keys": [
    {
      "subject": "string",
      "keyId": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "prefix": "string",
      "kind": "personal",
      "owner": {
        "id": "00000000-0000-4000-8000-000000000000",
        "label": "string"
      },
      "requests": 0,
      "limited": 0,
      "errors4xx": 0,
      "errors5xx": 0,
      "lastDay": "2026-10-11"
    }
  ],
  "users": [
    {
      "subject": "string",
      "userId": "00000000-0000-4000-8000-000000000000",
      "label": "string",
      "requests": 0,
      "limited": 0,
      "errors4xx": 0,
      "errors5xx": 0,
      "lastDay": "2026-10-11"
    }
  ],
  "anonymous": {
    "requests": 0,
    "limited": 0
  },
  "routes": [
    {
      "route": "string",
      "requests": 0,
      "limited": 0,
      "errors4xx": 0,
      "errors5xx": 0
    }
  ],
  "blocks": [
    {
      "subject": "string",
      "label": "string",
      "blockedUntil": "2026-10-11T12:00:00Z",
      "level": 0,
      "reason": "string",
      "blockedAt": "2026-10-11T12:00:00Z"
    }
  ],
  "tiers": [
    {
      "tier": "anonymous",
      "perMinute": 0,
      "perDay": 0,
      "description": "string"
    }
  ],
  "quotas": [
    {
      "bucket": "string",
      "perDay": 0,
      "description": "string"
    }
  ],
  "settings": {
    "personalKeysRequirePaid": true,
    "blockThreshold": 0,
    "blockWindowMinutes": 0,
    "blockMinutes": 0,
    "blockMaxMinutes": 0
  }
}

From the schema: placeholder values, not real data.

{ "since": "2026-10-11", "days": 0, "totals": { "requests": 0, "limited": 0, "errors4xx": 0, "errors5xx": 0 }, "daily": [ { "day": "2026-10-11", "requests": 0, "limited": 0, "errors": 0 } ], "keys": [ { "subject": "string", "keyId": "00000000-0000-4000-8000-000000000000", "name": "string", "prefix": "string", "kind": "personal", "owner": { "id": "00000000-0000-4000-8000-000000000000", "label": "string" }, "requests": 0, "limited": 0, "errors4xx": 0, "errors5xx": 0, "lastDay": "2026-10-11" } ], "users": [ { "subject": "string", "userId": "00000000-0000-4000-8000-000000000000", "label": "string", "requests": 0, "limited": 0, "errors4xx": 0, "errors5xx": 0, "lastDay": "2026-10-11" } ], "anonymous": { "requests": 0, "limited": 0 }, "routes": [ { "route": "string", "requests": 0, "limited": 0, "errors4xx": 0, "errors5xx": 0 } ], "blocks": [ { "subject": "string", "label": "string", "blockedUntil": "2026-10-11T12:00:00Z", "level": 0, "reason": "string", "blockedAt": "2026-10-11T12:00:00Z" } ], "tiers": [ { "tier": "anonymous", "perMinute": 0, "perDay": 0, "description": "string" } ], "quotas": [ { "bucket": "string", "perDay": 0, "description": "string" } ], "settings": { "personalKeysRequirePaid": true, "blockThreshold": 0, "blockWindowMinutes": 0, "blockMinutes": 0, "blockMaxMinutes": 0 } }