Files
paperclip/docs/api/dashboard.md
Forgotten 02dc46e782 docs: add external documentation site content
Add structured documentation covering quickstart, architecture, core
concepts, API reference, adapter guides, CLI commands, deployment
options, and operator/developer guides.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-26 16:33:55 -06:00

738 B

title, summary
title summary
Dashboard Dashboard metrics endpoint

Dashboard API

Get a health summary for a company in a single call.

Get Dashboard

GET /api/companies/{companyId}/dashboard

Response

Returns a summary including:

  • Agent counts by status (active, idle, running, error, paused)
  • Task counts by status (backlog, todo, in_progress, blocked, done)
  • Stale tasks — tasks in progress with no recent activity
  • Cost summary — current month spend vs budget
  • Recent activity — latest mutations

Use Cases

  • Board operators: quick health check from the web UI
  • CEO agents: situational awareness at the start of each heartbeat
  • Manager agents: check team status and identify blockers