You are viewing beta documentation for Formie 4.x.
Reports

Reports

For a getting-started walkthrough, see Saved reports and scheduled delivery.

Reports let you save a set of submission filters, columns and charts so you can review the same information again. For example, you can track how many enquiries arrived last week, grouped by form and excluding spam, then export the results without setting up the filters each time.

Open Formie → Reports to create and run reports. Report definitions sync through project config (opens new window), so filters, columns, and display settings deploy with your Craft project.

What a Report Includes

Each report combines:

AreaWhat it controls
GeneralName, handle, and which forms are included
FiltersDate windows (new reports default to the last month), complete/incomplete/spam, statuses, and more
ColumnsWhich submission attributes and fields appear in the table and export
DisplayChart type and summary layout on the report run screen
ExportExport filename pattern (with variable tokens)
ScheduledLinks to scheduled email delivery for this report

Running a report shows summary counts, a trend chart, and a paginated submissions table. Export downloads submission data using the report’s current filters and column settings.

Export Formats

From the report run screen, choose Export and pick a file type:

FormatTypical use
Excel (.xlsx)Spreadsheets and sharing with non-technical teams
CSV (.csv)Universal tabular import
JSON (.json)Feeds and developer tooling
XML (.xml)Structured interchange
Text (.txt)Plain tab-separated output

The file extension is added automatically from the format you choose. The Export Filename setting on the report editor controls the basename only — not the extension.

When columns share a label, exports add numbered suffixes such as Value (2) to keep every column distinct. Existing labels are preserved, so a suffix already used by another column is skipped. This applies to spreadsheet headings, JSON keys and XML column names; the report’s saved labels are unchanged.

Scheduled reports attach exports in the File Type you choose on each schedule (CSV, Excel, JSON, XML, or text). That uses the same export engine as on-demand downloads.

Large Exports

Reports with more submissions than the Report Async Export Row Threshold (Settings → Submissions, default 1000) are exported in the background via Craft’s queue. The control panel shows an Exporting… state while the export runs, and your download starts automatically when it is ready. If you leave the control panel before it finishes, a backup email with a download link is sent to your account email address when Craft’s mailer is configured.

All export formats write rows incrementally to disk, including Excel, JSON and XML. Formie records the matching submission IDs before exporting so new submissions cannot shift rows between batches. Field values are read as each batch is processed; submissions that are deleted or no longer match the filters are omitted. Scheduled reports still attach small exports to the summary email; when an export exceeds the Maximum Email Attachment Size (Settings → Notifications), the email includes a signed download link instead.

If a queue worker stops during an export, retry the failed job in Craft’s queue. The retry rebuilds the unfinished file and removes abandoned spreadsheet parts. Completed exports retain their existing download links when a job is repeated. If the backup email fails, the completed file remains available in the control panel.

Download links expire after Report Interactive Export Expiry or Report Scheduled Export Expiry (Settings → Submissions, defaults 72 and 48 hours). Single-Use Report Export Downloads is enabled by default so each signed email link works once; control panel auto-downloads use a separate authenticated route and do not invalidate email links.

Reports vs the Submissions Index

Submissions indexReports
PurposeDay-to-day submission managementSaved analysis and recurring output
FiltersPer-session element index filtersSaved, reusable filter sets
ExportNot available (use reports instead)On-demand export in multiple formats
Email delivery—Scheduled reports (configurable file type)

If you only need a one-off file, run a report and export in the format you need. If you need the same view every Monday morning, save the report and attach a scheduled delivery.

Export Filename

On the report editor Export tab, set Export Filename to control the basename for downloads and scheduled attachments.

The default pattern is formie-report-{handle}-{timestamp}. Use the variable picker to insert tokens such as:

  • {name} and {handle} — report title and handle
  • {timestamp} — current date and time when the file is generated
  • General and site tokens from the same picker used elsewhere in Formie

Tokens are resolved when the export runs, not when you save the report.

Permissions

Reports use dedicated Craft user permissions:

PermissionAllows
Access reportsView the Reports section and run saved reports
Manage reportsCreate, edit, and delete reports; export data
Manage scheduled reportsConfigure scheduled email delivery under Settings → Scheduled Reports and on a report’s Scheduled tab

Users with Export submissions can also export from reports without full manage access.

Project Config

Report settings are stored under formie.reports.{uid} in project config. Scheduled delivery settings (recipients, schedule, email content) are stored under formie.scheduledReports.{uid}.

Database-only fields such as lastSentAt live in the database and are not synced through project config.