Dashboard API
Reference for the Dashboard endpoint group — 2 endpoints.
Generated from the live OpenAPI spec. Re-run _generate_api_reference.py after backend changes.
Authentication#
All endpoints require a Bearer JWT in the Authorization header unless noted otherwise. See Concepts → Tokens and scopes and Reference → OAuth endpoints for how to obtain one.
Endpoints#
GET /api/v1/admin/dashboard/activity#
Get Recent Activity
Get recent activity from audit log.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
tenant_id |
query | no | string | null |
Filter by tenant |
partner_id |
query | no | string | null |
Filter by partner (all tenants in partner) |
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → object |
422 |
application/json → HTTPValidationError |
GET /api/v1/admin/dashboard/stats#
Get Dashboard Stats
Get dashboard statistics.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
tenant_id |
query | no | string | null |
Filter by tenant |
partner_id |
query | no | string | null |
Filter by partner (all tenants in partner) |
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → object |
422 |
application/json → HTTPValidationError |
Schemas#
Definitions for every type referenced by the endpoints above. Schema-to-schema references on this page link within the page; cross-page references would require visiting the linked page.
HTTPValidationError#
| Field | Type | Required | Description |
|---|---|---|---|
detail |
array of ValidationError |
no |
ValidationError#
| Field | Type | Required | Description |
|---|---|---|---|
loc |
array of string | integer |
yes | |
msg |
string |
yes | |
type |
string |
yes |