Guides

Building Dashboards

Create dashboards, add widgets, and configure layouts.

Dashboards are collections of widgets arranged on a 12-column grid. This guide covers the admin workflow.

Creating a Dashboard

  1. Go to Settings → Dashboards → New Dashboard
  2. Set name, description, and role visibility
  3. Optionally set as default dashboard for specific roles

Role visibility controls who sees the dashboard:

  • admin, manager, viewer — everyone
  • admin — admin only
  • admin, manager — admins and managers

Adding Widgets

Click "Add Widget" and choose:

KPI Card

Shows a single metric with period comparison.

Config fieldWhat it does
metricWhich metric to display (from semantic model)
periodTime period: this_month, this_week, last_30_days
comparison_periodPrevious period for % change: last_month, last_week
iconPrimeIcons class (e.g., pi pi-dollar)
colorCSS variable or hex color

Chart

Time-series or categorical visualization.

Config fieldWhat it does
metricWhat to measure
dimensionHow to slice (time or categorical)
chart_typeline, bar, or area
periodTime range
show_trendShow trend line overlay

Top N Table

Ranked list by metric value.

Config fieldWhat it does
metricWhat to rank by
dimensionWhat to list
limitHow many items (e.g., 5 for top 5)
sort_dirdesc (highest first) or asc
show_percentageShow % of total

Alert Feed

Recent agent alerts.

Config fieldWhat it does
max_itemsHow many alerts to show
severity_filter["warning", "critical"]
show_timestampDisplay time ago

Layout Configuration

Widgets are positioned on a 12-column grid:

┌──────────────────────┬──────────────────────┐
│   KPI: Bookings      │   KPI: Revenue       │
│   (w:6, h:4)         │   (w:6, h:4)         │
├──────────────────────────────┬───────────────┤
│   Chart: Daily Bookings      │  Alert Feed   │
│   (w:8, h:6)                 │  (w:4, h:6)   │
└──────────────────────────────┴───────────────┘

Position is stored as JSON: { "i": "w1", "x": 0, "y": 0, "w": 6, "h": 4 }

Setting a Default Dashboard

Mark one dashboard per role as default. When a user with that role logs in, they see this dashboard first. Each role can have a different default.

Metric Source of Truth

All widget metrics reference tenant_semantic.metrics by name. If a metric is renamed or deleted, affected widgets show a configuration warning in the admin UI.