Groundeddocs
ReferenceAdmin

Platform counts and attention items for the admin Overview (platform admins and auditors)

GET/v1/admin/overview

Teams, users and content counts, failed documents by team (top 10; a null team is the platform-shared sources), the resource caps of active teams used at 80% or more, fullest first, and the production-readiness warnings (also logged at startup and printed by grounded doctor). Pending domain requests are in GET /v1/admin/attention.

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/admin/overview"
{  "data": {    "teams": {      "active": 0,      "archived": 0    },    "users": {      "total": 0,      "suspended": 0,      "signedInLast7Days": 0,      "platformAdmins": 0    },    "content": {      "documents": 0,      "failedDocuments": 0,      "passages": 0,      "storageBytes": 0,      "sharedSources": 0    },    "failedIngest": [      {        "teamSlug": "string",        "teamName": "string",        "failed": 0      }    ],    "teamsNearLimits": [      {        "teamSlug": "string",        "teamName": "string",        "key": "storage_bytes",        "label": "string",        "unit": "count",        "used": 0,        "max": 0      }    ],    "teamsNearBudget": [      {        "teamSlug": "string",        "teamName": "string",        "state": "warning",        "percent": 0,        "spent": "12.500000",        "limit": "12.500000",        "currency": "string"      }    ],    "warnings": [      {        "code": "crawl_allowlist_empty",        "severity": "warning",        "message": "The crawl allowlist is empty, so no web source can be crawled.",        "fix": "string"      }    ]  }}