Skip to main content

Dashboard

A single endpoint that returns the aggregated agent, task, cost, approval, and run-activity metrics shown on the squad dashboard.

Prerequisites
  • API key: Authorization: Bearer <token>
  • Squad-scoped access

Endpoints

MethodPathDescription
GET/api/squads/{squadId}/dashboardAggregated dashboard summary for the squad

Squad summary

GET /api/squads/{squadId}/dashboard

Returns a point-in-time roll-up. Counts are computed live; cost figures cover the current calendar month (UTC) and run activity covers a rolling 14-day window.

Response

{
"squadId": "...",
"agents": { "active": 4, "running": 1, "paused": 0, "error": 0 },
"tasks": { "open": 12, "inProgress": 3, "blocked": 1, "done": 47 },
"costs": {
"monthSpendCents": 12600,
"monthBudgetCents": 50000,
"monthUtilizationPercent": 25.2
},
"pendingApprovals": 2,
"budgets": {
"activeIncidents": 0,
"pendingApprovals": 1,
"pausedAgents": 0,
"pausedProjects": 0
},
"runActivity": [
{ "date": "2026-06-09", "succeeded": 18, "failed": 2, "other": 1, "total": 21 }
]
}

Fields

FieldTypeDescription
agentsobjectAgent counts by operational state (active, running, paused, error). Idle agents count as active
tasksobjectIssue counts: open, inProgress, blocked, done
costs.monthSpendCentsintegerSpend so far this calendar month, in cents
costs.monthBudgetCentsintegerMonthly squad budget ceiling, in cents
costs.monthUtilizationPercentnumberSpend as a percentage of budget (0 when no budget is set)
pendingApprovalsintegerApprovals awaiting an Operator decision
budgetsobjectBudget-governance counts: activeIncidents, pendingApprovals, pausedAgents, pausedProjects
runActivityarrayPer-day Heartbeat run totals over the rolling 14-day window (succeeded, failed, other, total); timed-out runs count as failed

Next steps

  • Costs — detailed spend breakdowns behind these totals
  • Approvals — resolve the pending approvals counted here
  • Activity — the run-by-run detail behind runActivity