Files
paperclip/docs/api/dashboard.md
Dotta 09d2ef1a37 fix: restore docs deleted in v0.2.3 release, add Paperclip branding
- Restored docs/ directory that was accidentally deleted by `git add -A`
  in the v0.2.3 release script
- Replaced generic "P" favicon with actual paperclip icon using brand
  primary color (#2563EB)
- Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark)
- Updated docs.json with logo configuration for dark/light mode
- Fixed release.sh to stage only release-related files instead of `git add -A`
  to prevent sweeping unrelated changes into release commits

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-03 15:49:43 -06:00

721 B

title, summary
title summary
Dashboard Dashboard metrics endpoint

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