API reference
Home summary
One request for a workspace's home view - alerts computed from its own records, the last 7 days against the 7 before, recent calls and agents.
The dashboard's Home page reads everything it shows from one endpoint. You can call it too, for example to put the same alerts on your own status board.
| Operation | Method and path | Minimum role |
|---|---|---|
| Get the home summary | GET /dashboard/home | viewer |
An API key acts as admin.
Get the home summary
GET /dashboard/home
| Query parameter | Meaning |
|---|---|
tz | The IANA time zone days are counted in, such as Asia/Kolkata. Default UTC; an unknown zone is a 400. |
include_simulated | true counts simulated calls in the figures and lists. Default false. |
curl "https://api.sevennadi.si/dashboard/home?tz=Asia/Kolkata" \
-H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef"Response 200 OK
alerts: what needs attention, most severe first. Each has akind, aseverity(high,mediumorlow), atitle, a one-sentencemessage, and theagent_idandagent_nameit is about (ornull). Every alert comes from stored data:kindRaised when workflow_testsThe agent's latest workflow-test run had failed scenarios or failed safety probes ( high), flaky scenarios (low), or stopped with an error. Carriesrun_id.simulated_callsThe agent's latest simulated-call run had calls that failed their checks, or stopped with an error. Carries run_id.walletThe balance is below the low-balance threshold ( medium) or has run out (high).safety_stepsCalls today whose graph path reached a node that one of the agent's safety transitions ( global_edges) leads to.call_errorsCalls of the agent that ended failedorerrorin the last 24 hours (highfrom 5).pipelineThe agent's voice pipeline is not configured, disabled or gone, so its calls fail. Carries pipeline.engineThe platform checks its voice engine's health and the check failed. Never raised when the platform has no health check. incidentOnly in the platform operator's own workspace: an open incident from the platform's monitoring (a model server or the voice engine unreachable, slow speech-to-text, a high call error rate, a job backlog, low disk space, a stale backup). The title says since when ("Model server unreachable (STT) since 23:45", in tz); carriessinceand anincidentobject (id,key,kind,severity,opened_at). A customer workspace never receives it.monitoringOnly in the operator's workspace: the monitoring itself has stopped reporting (carries since).
kpis:current(the last 7 days, today included) andprevious(the 7 days before), each withcalls,completed,failed,completion_rate(completed out of calls that ended,nullwhen none ended),safety_triggersandspend(call cost in major units ofcurrency).calls_per_day: the last 7 days, oldest first:date,calls,completed,failed,spend.recent_calls: the 5 latest calls, withagent_name,status,to_number,conversation_duration,total_cost(minor units) andsimulated.agents: every agent, most recently updated first, withkind(promptorgraph), itspipeline(id,name,status) andcalls_7d.wallet:balance,currency,low_balance_threshold,low.engine:{"ok": true|false}when the platform checks its voice engine, elsenull.
The per-call response time is not stored on calls, so it is not part of the figures; simulated-call runs report their own latency.