dashboards/<id>.yaml

One file for each dashboard. The name of the file is the id of the dashboard. See dashboards and filters and selections.

key	type	default	description
filters	list of FilterSpec	[]	Filter widgets, shown above the visuals.
layout	Layout
name	string	required	The title shown in the UI.
visuals	list of Visual	[]

FilterSpec

key	type	default	description
default	RelativeWindow		A date_range's selection when the dashboard is opened: a window relative to now, such as { last: 7, unit: day }. It moves as time passes; a viewer can change or clear it.
field	string	required	dataset.field.
measure	string		A metric shown beside each value instead of its row count, computed for that value under the rest of the selection (OEE per line).
widget	FilterWidget	list

Layout

key	type	default	description
columns	integer	12
row_height	integer	80	Height of one grid row, in pixels.

Visual

key	type	default	description
across	list of DimensionRef		Pivot tables: the dimensions along the top, their values as columns.
at	GridPosition	required
compare	string		KPI tiles: a second metric shown as the comparison.
description	string		What it shows, in a sentence: under its title, and for agents.
dimensions	list of DimensionRef
format	map of string		How each metric shows in this visual, by the name of the metric: { revenue: compact }. It replaces the format of the metric here. It changes only what shows on the screen, not the value.
id	string	required	Unique within the dashboard.
limit	integer
metrics	list of string		Metrics by name. A filter has none. A table without metrics shows each combination of its dimensions that the data has.
on_brush	BrushAction		Line charts: what brushing the time axis does.
on_click	ClickAction		Bars and table rows: what a click does.
sort	Sort
title	string		What its header says; made from its metrics and dimensions when left out.
totals	boolean		Pivot tables: a total row and a total column.
type	VisualType	required

RelativeWindow

Whole periods relative to now: the last ones of unit, ending with the current one, or ago periods before it. { last: 7, unit: day } is today and the six days before it; { last: 1, unit: month, ago: 1 } is last month. Periods start where time grains do (weeks on Monday), in UTC.

key	type	default	description
ago	integer	0
last	integer	required
unit	WindowUnit	required

FilterWidget

value	description
list	A searchable list of values.
date_range	A from/to range, for time fields.
tree	An expandable tree, for a dataset's hierarchy field (the default for one).
search	A text box, for a string field: the rows whose value contains what is typed are selected, ignoring the case of ASCII letters.

DimensionRef

A dimension: dataset.field, or a time field at a grain.

One of:

• string
• object with field, grain

GridPosition

key	type	default	description
h	integer	required
w	integer	required
x	integer	required
y	integer	required

BrushAction

Type: select_range.

ClickAction

Type: select.

Sort

key	type	default	description
by	string	required	A metric or a dimension of the visual.
desc	boolean	false

VisualType

value	description
kpi	Metrics as large numbers, with no dimensions. compare adds a second metric and the change from it.
bar	Bars: one dimension, one or more metrics. A click selects a bar, a drag several.
line	A line over one dimension, usually a time field with a grain, with one or two metrics. A drag across it selects a range.
table	Rows of dimensions and metrics, sortable. Without metrics: the combinations of the dimensions there are.
pie	Slices of a whole: one dimension, one metric. The largest limit slices (8 when not given, 12 at most); for a sum or a count, the rest as one more slice. A click selects a slice.
scatter	Points by one dimension: the first metric across, the second up, a third (if any) as each point's size. limit points (1000 when not given, 5000 at most). A click selects a point, a drag the points in its rectangle.
heatmap	A grid of cells by two dimensions (across, up), each coloured by one metric: weekday by hour, region by category. limit cells (2000 when not given, 10000 at most). A click selects both of a cell's values, a drag the values in its rectangle.
pivot	A pivot table: dimensions down the side (one to three), across along the top (none to two), every metric in each cell. totals adds a total row and column, computed as the metric over each, not summed: right for averages and distinct counts too.
filter	The values of one dimension as a list on the grid. A click selects a value, as in a filter on the rail. It has no metrics.
rows	The newest rows of one table that pass the selection, newest first: a log tail. Its dimensions are the columns; limit is how many rows (100 when not given, 1000 at most). It has no metrics.

WindowUnit

Type: minute · hour · day · week · month · quarter · year.