README

Privacy-friendly form submission statistics for Contao 5.

Contao Form Analytics records successful submissions from native Contao forms and provides an analytics dashboard in the Contao back end.

By default, no submitted form values, names, email addresses or IP addresses are stored. Administrators can explicitly enable anonymous statistical analysis for selected choice fields.

Features

Counts successful native Contao form submissions
Does not count forms with validation errors
Dashboard in the Contao back end
Statistics for:
- Today
- Current month
- Last 7 days
- Last 30 days
- All time
- Custom date ranges
Statistics grouped by form, website and page
Configurable analytics dimensions
Value distribution by analytics dimension
Combined reports by form type and dimension
Supports shared dimensions across multiple forms
Supports select, radio and checkbox fields
Detailed submission list with filtering, sorting and search
CSV export for individual submissions
Aggregated CSV export for dimension reports
Supports multiple root pages and websites
German and English translations
Privacy-friendly by design

Requirements

PHP 8.1 or newer
Contao 5.3 or newer

Installation

Install the bundle with Composer:

composer require izicloud/contao-form-analytics

Then run the Contao migrations:

php vendor/bin/contao-console contao:migrate

Alternatively, use the database migration in the Contao Manager.

Usage

After installation, open:

Content → Form analytics

The dashboard displays the total number of successful submissions and statistics for the selected period.

Use Show all submissions to open the detailed list.

Use Export CSV to export individual submissions from the selected period.

Use Export analysis as CSV to export the aggregated dimension report.

Analytics dimensions

Selected form fields can be enabled for anonymous statistical analysis.

Open a select, radio or checkbox field in the Contao form generator and enable:

Include in analytics

Then configure:

Dimension key
Dimension label

The dimension key connects fields from different forms to the same report.

Example:

Field name: source
Dimension key: origin
Dimension label: How did you hear about us?

Another form can use a different field name while sharing the same dimension key:

Field name: how_found
Dimension key: origin
Dimension label: How did you hear about us?

Both fields will be evaluated together.

Technical option values should be consistent across forms. For example, use google as the option value and Google as the visible option label in every connected form.

For checkbox groups, every selected option is counted once. The total number of submissions remains independent and counts the submitted form only once.

Stored data

For each successful form submission, the extension stores:

Form ID
Form title
Form alias
Page ID
Page title
Page alias
Root page ID
Root page title
Submission timestamp

For fields explicitly enabled for analytics, it additionally stores:

Form field ID
Original field name
Original field label
Analytics dimension key
Analytics dimension label
Selected technical option value
Selected visible option label

The extension does not store:

Values from fields not explicitly enabled for analytics
Names
Email addresses
Telephone numbers
Free-text messages
Uploaded files
IP addresses
User agent information

Analytics should only be enabled for anonymous choice fields without personal data.

Existing submissions

The extension starts collecting statistics after installation.

Analytics dimensions and selected option values cannot be reconstructed for submissions recorded before the corresponding field was enabled.

Form submission and email transport

The extension records successful submissions from the native Contao form generator through the processFormData hook.

Statistics are independent of the configured email transport. Native Contao email sending, SMTP transport and form notifications handled by Notification Center can therefore be used without changing the analytics configuration.

Notifications that are triggered independently and do not originate from a native Contao form are not recorded.

CSV export

CSV files use:

UTF-8 encoding with BOM
Semicolon separators
Spreadsheet formula injection protection

Two CSV exports are available:

Individual submission export
Aggregated dimension report

License

This bundle is licensed under the MIT License.

Support and development

Developed by izicloud Ltd..

izicloud / contao-form-analytics

Package info

Security

Statistics