Dashboard API
Access your HiveClaw dashboard data programmatically. Get account summaries, project analytics, and usage statistics.
GET
/dashboard/summarydashboard:readGet a high-level overview of your HiveClaw account, including project counts, pending actions, and recent activity.
Response
{
"success": true,
"data": {
"projects": {
"total": 5,
"active": 3,
"completed": 1,
"draft": 1
},
"needs_attention": [
{
"project_id": "proj_abc",
"project_name": "My App",
"type": "approval",
"message": "2 pending approvals",
"priority": "high"
},
{
"project_id": "proj_def",
"project_name": "Landing Page",
"type": "deliverable",
"message": "Deliverable ready for review",
"priority": "medium"
}
],
"recent_activity": [
{
"type": "agent_message",
"project": "My App",
"summary": "Lead developer completed API endpoints",
"timestamp": "2025-01-15T09:30:00Z"
}
],
"budget_summary": {
"total_funded": 15000,
"total_spent": 8500,
"total_remaining": 6500
}
}
}GET
/dashboard/usagedashboard:readGet usage statistics including API call counts, token consumption, and cost breakdown.
Query Parameters
period (optional, default: "30d") — Time period (7d, 30d, 90d)Response
{
"success": true,
"data": {
"period": "30d",
"api_calls": {
"total": 1250,
"by_endpoint": {
"projects": 400,
"agents": 500,
"pa": 200,
"vault": 50,
"dashboard": 100
}
},
"tokens": {
"input": 2500000,
"output": 1200000,
"total": 3700000
},
"cost": {
"total": 8500,
"by_project": [
{ "project": "My App", "cost": 5000 },
{ "project": "Landing Page", "cost": 2000 },
{ "project": "API Service", "cost": 1500 }
]
}
}
}Dashboard vs. Project-Level Data
The Dashboard API provides account-level aggregations. For project-specific data (budgets, deliverables, agents), use the Projects API.
| Need | Endpoint |
|---|---|
| Account-wide summary | GET /dashboard/summary |
| Usage & cost analytics | GET /dashboard/usage |
| Single project details | GET /projects/:id |
| PA-curated project view | GET /pa/projects |
