Build a Report

This page walks through building a report on a table. When you're finished the report will be ready to run on its own or embed on a dashboard.

Building reports requires an application where your role has admin or limited admin access. End users without admin access can still create personal reports for themselves from Advanced Search.

Steps

  1. Open the table's Settings, look under the User Interface panel, and click Reports.

  2. Click Add Report to open the report builder. The builder is organised into collapsible sections.

  3. In Basics, enter a Report Name (required), an optional Description, and pick the report Type: Table, Summary, Chart, Kanban, Calendar, Map, Image Gallery, or Many-to-Many. Set Visibility to Only Me, Everyone, or Specific Roles, and turn on Display on Menu if the report should appear in the navigation.

  4. In Control Bar, choose which tools users get above the report: text search, the query builder, facets, edit mode (with optional add and delete), and data or file export. Set the Search Type to Like or Lexeme if you want to override the table's default.

  5. Configure the section for your report type. A few common ones:

    • Table: pick and order Columns, build a Query to filter which records appear, and set Sorting.
    • Chart: pick a chart subtype (bar, stacked bar, line variants, pie, funnel, or scatter), configure the X Axis and Y Axis, and optionally set a Details Report so clicking a segment drills into the records.
    • Summary: choose what to Summarize and how to Group the results.
    • Calendar: pick the start and end date fields.
    • Map: choose a GPS field for the pins.

  6. Table, Kanban, Calendar, and Map reports also have an Advanced section: turn on Display Edit / Display View with the forms to use, and set Color Coding to highlight rows with a formula.

  7. Click Save to return to the Reports list. Run the report with its eye icon in the list, or open it from the menu if Display on Menu is on.

Putting it on a dashboard

Drag the report from the palette onto a dashboard canvas. Each report can appear once per dashboard, and the embedded copy includes a Full Report link that opens it standalone.

Where to go next

The same report builder is reflected in the REST API. See the Reports endpoint reference.