kind: dashboard declares a dashboard: its window, the filters over every widget, and its widgets top to bottom. A widget is an analytics query plus a name, a chart type and a size, so a query you tried over the API drops straight into a widget.
Fields
Widgets
References
- Metrics resolve by slug: a
kind: metricin the same config (applied first), or any metric the project can see, system metrics included. - Agents in an agent filter can be written by their config name; Roark resolves them to ids, the same way other kinds reference agents.
AVG of a classification, or naming a metric that doesn’t exist, fails that dashboard’s apply with the reason, and the dashboard is left exactly as it was.
In Roark
A dashboard created by config shows Managed by config. Its title and widgets are read-only in Roark and over the API (edits return409): change them in your config and re-apply. Anyone viewing it can still pick a time range and filter it, and an apply only overwrites those when the config declares timeRange or filters. Duplicating a managed dashboard gives you an editable copy.
A dashboard made in Roark with the same title as a kind: dashboard (its displayName, or name) is adopted on the first apply rather than duplicated, as long as exactly one unmanaged dashboard has that title.