Viewing reports
The reports section is where producers and admins see the data their surveys collect, summarised across projects with charts, tables, and diversity-index scores. There are two entry points: a simpler “Essential” view and a more detailed “Advanced” view.
What happens
Section titled “What happens”The user opens the reports page, picks the scope (which projects, which period), selects what to display (demographics, roles, group-by, chart type), and the page renders the result. Export options let them download the underlying data as CSV, Excel, or PDF.
What the user sees
Section titled “What the user sees”Two entry points
Section titled “Two entry points”| Page | Audience |
|---|---|
/reports (Essential) | Lighter-weight view; default for most producers |
/reports/advanced | More controls and slicing; for users who need finer detail |
Filters
Section titled “Filters”| Filter | What it controls |
|---|---|
| Projects | Multi-select; default “All Projects” |
| Scope | Financial year / Calendar year / Custom period (with start and end dates) |
| Benchmarks | Toggles for prior-year, industry, and population benchmarks |
Display options
Section titled “Display options”| Option | What it controls |
|---|---|
| Demographics | Age, gender, disability, ethnicity, socio-economic, LGBTQI+, language, religion |
| Roles | Multi-select; depends on your project’s roles |
| Group by | Role / project / other groupings |
| Chart type | Bar / line / pie / column |
What gets rendered
Section titled “What gets rendered”- Charts — one per metric, with title and subtitle
- Diversity index — a summary score (0-10) with relative and absolute components
- Tables with export buttons — CSV, Excel, PDF download options
Translation keys
Section titled “Translation keys”All visible text lives under Reports.* in tep-configuration/translations/{locale}/main/reports.json. Chart titles and subtitles, filter labels, display options — every piece is translatable.
What you can customise
Section titled “What you can customise”Translations
Section titled “Translations”Reports.* keys in tep-configuration/translations/{locale}/main/reports.json. Override per client.
Which metrics, demographics, and benchmarks appear
Section titled “Which metrics, demographics, and benchmarks appear”The set of available metrics, demographics, and benchmarks is driven by your reporting analysis config (tep-configuration/clients/{client}/reporting/analysis_config.json). You decide which charts your customers see by editing that file.
Per-client population concordance
Section titled “Per-client population concordance”The population reference data (used for “population benchmark”) comes from tep-configuration/clients/{client}/reporting/population_concordance.json. Each client supplies their own demographic baselines.
Per-client reporting translations
Section titled “Per-client reporting translations”Reporting-specific strings (table names, grouping names, etc.) live alongside the reporting config:
tep-configuration/clients/{client}/reporting/translations/{locale}.jsonThis is separate from the global reports.json namespace — it covers strings that are reporting-config-specific (e.g. the name of a custom table or grouping you defined).
Variations for your deployment
Section titled “Variations for your deployment”| Your deployment | What’s different |
|---|---|
| All clients | Both Essential and Advanced views are available; specifics differ per client config |
| CDN, NZ, Omni, TEP | Each ships its own analysis_config.json and population_concordance.json; metrics and benchmarks vary accordingly |
Need more detail?
Section titled “Need more detail?”The reporting UI itself lives in an external package (@the-everyone-project/reporting-ui) — the tep-client repo is a thin wrapper. For engineering context on the wrapper and what is and isn’t owned in tep-client, see Viewing reports (engineering).