Skip to content
Ishvana Ishvana Docs

Get System Overview

GET
/api/agents/swarm/system/overview

Get comprehensive system overview

Retrieves system-wide swarm statistics including active swarm counts, total resource utilization across all swarms, overall system health status, and aggregate performance metrics. Provides high-level view of swarm system state.

@param management_interface: Injected swarm management interface @returns SystemOverviewResponse with system statistics, resource usage, and health status @raises HTTPException: If overview retrieval fails (500)

Overview Includes:

  • Active swarm count and types distribution
  • Total resource utilization (CPU, memory, agents)
  • System health status and alerts
  • Aggregate performance metrics
  • Historical swarm statistics

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

SystemOverviewResponse

Response model for swarm system overview.

Provides comprehensive system-wide swarm statistics including active swarm counts, total resource utilization across all swarms, overall system health status, and aggregate performance metrics for high-level system monitoring.

Fields:

  • active_count: Number of currently active swarms (integer)
  • total_resources: Dictionary containing total resource utilization across all swarms
  • health_status: Overall system health status string (e.g., “healthy”, “degraded”)
  • performance_summary: Dictionary containing aggregate performance metrics
  • swarm_types_distribution: Dictionary mapping swarm types to active counts
  • historical_statistics: Dictionary containing historical swarm statistics

Usage: GET /api/swarm/system/overview returns this response model with system-wide swarm statistics and resource utilization.

JSON Example:

{
  "active_count": 5,
  "total_resources": {
    "cpu_usage_percent": 65.2,
    "memory_usage_mb": 2048,
    "active_agents": 25
  },
  "health_status": "healthy",
  "performance_summary": {
    "average_efficiency": 0.85,
    "total_completed": 150,
    "total_failed": 5
  },
  "swarm_types_distribution": {
    "code_analysis": 2,
    "testing": 1,
    "performance": 2
  },
  "historical_statistics": {
    "total_swarms": 200,
    "success_rate": 0.95
  }
}
object
activeCount
Activecount

Number of active swarms

integer
0
totalResources

Total resource utilization across all swarms

object
key
additional properties
any
healthStatus
Healthstatus

Overall system health status

string
default: unknown
performanceSummary

Aggregate performance metrics

object
key
additional properties
any
swarmTypesDistribution
Swarmtypesdistribution

Distribution of swarm types by active count

object
key
additional properties
integer
historicalStatistics

Historical swarm statistics

object
key
additional properties
any