KPI

A KPI widget shows one number, the result of aggregating a data source. It's the right widget for a headline figure: a total, a count, an average. For the shared editor mechanics, see Build a canvas.

Set the number

In the Data panel:

1. Set the Data source to the object the KPI reads from.
2. Set the Metric to the attribute the number is based on. The metric can reach across a relationship to an attribute on a linked object.
3. Pick a Function to compute it: Count, Count distinct, Sum, Avg, Min or Max (choose None to leave it unaggregated). The numeric functions require a numeric metric.
4. Use Filters in the same panel to scope which records feed the number.

The KPI then displays the metric aggregated by the function across every record that passes the filters. Until you give it a title, a KPI is named after its source, its metric and its function.

In edit mode, a click on the KPI's number opens it in the widget dialog, as Edit widget in its ⋯ does.

How the number is formatted

A KPI formats its value with the metric attribute's own display configuration: format, decimal places, separators, and any prefix, suffix or multiplier. Set it on the attribute in Data and the KPI follows. See Format how a number displays.

A metric with no display configuration falls back to a shortened form, which suits a headline count. Configure the attribute when the exact figure matters, for example a rate that needs four decimals.

Appearance

The Appearance panel has one setting, KPI color, which tints the widget.

On the canvas, the number and its label (the widget's title) sit together at the left of the card, centred vertically at any height. A value wider than its card is cut short with an ellipsis; hover it to read the whole number.

Export

Hover the KPI to reveal its ⋯ menu. You can Export chart (the single value as a CSV), Export data (the underlying records as a CSV), or Export card (the KPI as a PNG). KPI widgets don't have an expand view.

Where to go next

• Chart
• Table
• Build a canvas