Guides/Dynamic Dashboards

Dynamic Dashboards

Agent-defined dashboards via dashboard.yaml with 11 widget types, historical tracking, and sparkline charts.

Concepts

•dashboard.yaml — A YAML file in the agent's workspace defining custom widgets. The agent writes and updates this file to control what appears on its Dashboard tab.

•Widget Types — There are 11 supported types: metric, status, progress, table, list, chart, text, badge, countdown, link, image.

•Historical Tracking — Widget values are stored in the agent_dashboard_values table over time, enabling trend analysis.

•Sparklines — Small inline charts rendered next to metrics showing value trends over time.

•Trend Indicators — Up, down, or stable arrows with percentage change calculated from historical data.

•Platform Metrics — An auto-injected section (not defined in dashboard.yaml) showing Tasks 24h, Success Rate, Cost, and Health.

How It Works

The agent writes a dashboard.yaml file to its workspace.

The file defines widgets with type, title, value, and optional configuration fields.

Open the agent detail page and select the Dashboard tab to see the widgets.

Auto-refresh updates values as the agent modifies the YAML file.

Historical values are tracked automatically — sparklines appear for metrics with enough data points.

A Platform Metrics section appears at the bottom of every dashboard. This section is auto-injected and not controlled by the YAML file.

For Agents

Agents control their dashboard entirely by writing to dashboard.yamlin their workspace. No API call is needed to publish changes — the file is read on each dashboard request.

API

Endpoint	Method	Description
/api/agents/{name}/dashboard	GET	Get dashboard data

Query Parameters

Parameter	Type	Description
include_history	bool	Include historical value data
history_hours	int	Number of hours of history to return
include_platform_metrics	bool	Include the auto-injected platform metrics section

Process Engine