Dashboards
A dashboard is a collection of widgets arranged in a 12-column grid. Each widget queries a specific event and displays a visualization.
Dashboards sit between the raw event model and the browser runtime: they define the surface that later gets published, embedded, and scoped.
Surface lifecycle
A dashboard goes through three practical stages before a customer sees it inside your product.
/v1/embed-sessions.Widget types
| Kind | Charts | Use case |
|---|---|---|
kpi | stat, progress | Single number or quota-style progress card |
timeseries | bar, area, line, stacked_bar | Trend or composition over time |
breakdown | list, horizontal_bar, donut | Top-N, mix, or share by dimension |
table | table | Detailed rows |
Metrics
count— number of eventscount_unique— distinct user_id countcount_unique_approx— approximate distinct user_id count via ClickHouse HLL, with HLL rollup merges on safe hourly/daily pathssum— sum of a numeric propertyavg— average of a numeric propertyp95/p99— percentile metrics for numeric properties like latency or duration
Filters
Dashboard config can include interactive filters:
- Period selector: 1h, 24h, 7d, 30d, 90d
- Dimension filters: single-select or multi-select on string properties
- Numeric range: min/max on numeric properties
- Date range: custom from/to dates
For common SaaS dimensions like model, endpoint, status, plan, and source, safe count trend and grouped widgets can stay on filtered hourly/daily rollups instead of always falling back to raw events.
Draft vs Published
Dashboards have two states:
- Draft: Editable in the builder. Changes are visible only in preview and do not affect the customer-facing embed.
- Published: The live snapshot shown in embed iframes. Click "Publish" in the builder to replace the currently served snapshot with the latest draft.
Auto-create
Emban can scan your events and automatically generate a dashboard. Use the "Auto-create" button in the builder or call:
POST /v1/discover/auto-create
Authorization: Bearer YOUR_ADMIN_API_KEY
This creates a draft dashboard with KPIs, timeseries, share, and ranking widgets based on your event schema.