Skip to content

Admin Dashboard & Audit API

Platform-level administration endpoints for system overview and global audit logs. Requires platform admin role.

System Dashboard

Returns aggregate statistics across all organizations, workspaces, and projects.

http
GET /api/v1/admin/dashboard
Authorization: Bearer <token>

Response 200 OK

json
{
  "users": {
    "total": 150,
    "active": 120,
    "pending": 5
  },
  "workspaces": {
    "total": 25
  },
  "projects": {
    "total": 80
  },
  "requirements": {
    "total": 450,
    "by_status": {
      "draft": 20,
      "analyzing": 5,
      "ready": 30,
      "in_progress": 15,
      "completed": 350,
      "cancelled": 30
    }
  },
  "executions": {
    "total": 1200,
    "by_status": {
      "pending": 3,
      "running": 5,
      "completed": 1100,
      "failed": 80,
      "cancelled": 12
    }
  },
  "cost": {
    "total_usd": 4567.89,
    "total_tokens": 125000000
  },
  "runtimes": {
    "total": 12,
    "online": 8
  },
  "work_items": {
    "total": 3200,
    "by_status": {
      "todo": 150,
      "in_progress": 45,
      "review": 20,
      "done": 2800,
      "cancelled": 185
    }
  },
  "daily_executions": [
    { "date": "2026-05-15", "count": 42 },
    { "date": "2026-05-14", "count": 38 }
  ],
  "top_workspaces": [
    { "name": "Backend Team", "execution_count": 245 },
    { "name": "Frontend Team", "execution_count": 180 }
  ]
}

Global Audit Logs

Returns paginated audit log entries across all organizations and workspaces.

http
GET /api/v1/admin/audit-logs?page=1&page_size=20
Authorization: Bearer <token>

Query Parameters

ParameterTypeDescription
actionstringFilter by action (e.g. project.created)
actor_idUUIDFilter by actor
resource_typestringFilter by resource type
workspace_idUUIDFilter by workspace
start_datedatetimeStart of date range (ISO 8601)
end_datedatetimeEnd of date range (ISO 8601)
pageintPage number (default 1)
page_sizeintItems per page (default 20)

Response 200 OK

json
{
  "total": 5000,
  "page": 1,
  "page_size": 20,
  "items": [
    {
      "id": "uuid",
      "organization_id": "uuid",
      "organization_name": "Acme Corp",
      "workspace_id": "uuid",
      "workspace_name": "Backend Team",
      "project_id": "uuid",
      "actor_type": "human",
      "actor_id": "uuid",
      "actor_name": "Alice Chen",
      "action": "project.created",
      "resource_type": "project",
      "resource_id": "uuid",
      "detail": "Created project 'Payment Service'",
      "ip_address": "192.168.1.100",
      "created_at": "2026-05-16T10:30:00Z"
    }
  ]
}

Audit Log Fields

FieldDescription
organization_id / organization_nameThe organization context (may be null for system-level events)
workspace_id / workspace_nameThe workspace context (may be null for org-level events)
project_idThe project context (may be null)
actor_typehuman or agent
actor_nameDisplay name of the actor
actionDot-notation action (e.g. member.added, execution.started)
resource_typeType of resource affected
ip_addressClient IP address for human actions

Forgexa — AI Software Factory