Adding KPI Sections to a Report
Description
KPI sections display summary cards above the data table in published Dynamic Reports. Each KPI card shows a computed value — such as a count of rows, a sum of values, or an average — giving readers an at-a-glance overview of key metrics without scanning the full table.
Why Use KPI Sections?
Data tables are powerful but can be overwhelming. KPI cards distil your report into the numbers that matter most: total plans, average completion percentage, sum of estimated hours, or count of active items. They appear prominently above the data table, making them the first thing readers see.
Restrictions
KPI values are computed by the
ReportBuilderKpiComputationengine based on your filtered datasetEach KPI requires a label and an aggregate type (count, sum, or average)
The Distinct toggle only applies to count aggregates
KPI sections are saved as part of the report builder configuration and require the report to be re-saved to reflect changes in published views
Quick Steps
Opening the KPI/Sections Editor
Open your report in the Report Designer
Navigate to the KPI/Sections editor panel
Adding a KPI Item
Click Add KPI
Enter a Label (e.g., "Total Plans", "Active Items", "Avg Progress")
Select an Aggregate Type:
Count — counts the number of rows (or distinct values when Distinct is enabled)
Sum — totals the values of the selected field across all filtered rows
Avg — calculates the arithmetic mean of the selected field values across filtered rows
If using Sum or Avg, select the field to aggregate
Configuring the Distinct Toggle
When Distinct is enabled (true), the count deduplicates by the KPI field before counting — each unique value is counted only once
When Distinct is disabled (false, the default), all rows are counted including duplicates
Adding a Per-KPI Filter
Optionally, add a filter to a KPI to narrow its calculation scope
A KPI filter uses a field, operator, and value
Example: count only rows where Status = Active, or sum only where Priority = High
The KPI filter is independent of the main report filter — it further narrows the dataset for that specific KPI
Editing and Removing KPIs
To edit an existing KPI, click on it and change the label, aggregate type, field, or filter
To remove a KPI, click the remove button — it is removed from the sections JSON
Saving KPI Sections
Click Save Sections to persist your KPI configuration
KPI sections are saved via
POST /reportbuilder/SaveSectionswith theSectionsJsonpayloadClick Preview to see updated KPI values based on current data and filters
Important Notes
KPI cards are computed dynamically based on your filtered dataset. Changing the main report filter rules will affect KPI values — always preview after modifying filters.
The Distinct toggle is only meaningful for Count aggregates. It has no effect on Sum or Average calculations.
Per-KPI filters are additive to the main report filter. A KPI with a filter of "Status = Active" will only count/sum/average rows that match both the main report filter AND the KPI filter.
Further Information
What is Dynamic Reporting? — Overview of the Dynamic Reporting feature
Filtering and Grouping Report Data — Configure report-level filters that affect KPI calculations
Publishing and Previewing a Dynamic Report — Publish your report with KPI cards visible
Exporting Dynamic Reports — PDF exports include KPI cards above the data table