Reports


Highly customizable reports can be generated through Mautic's Report menu.

Data Sources

Choose the data source appropriate to the report you want. Each data source has a different set of available columns, filters and graphs.

The Details tab in the Edit Report window

Types of data sources available are as below -

  1. Assets
    1. Assets
    2. Asset Downloads
  2. Campaigns
    1. Campaign Events
  3. Channels Messages
    1. Message Queue
  4. Emails
    1. Emails
    2. Emails Sent
  5. Forms
    1. Forms
    2. Form Submissions
  6. Contacts
    1. Contacts
    2. Multi Touch Attributions
    3. First Touch Attributions
    4. Last Touch Attributions
    5. Contact Point Log
    6. Frequency Rules
    7. Segment Membership
    8. Do Not Contact
    9. UTM Codes
  7. Companies
    1. Companies
  8. Mobile Notifications
    1. Mobile Notifications
    2. Mobile Notifications Sent
  9. Pages
    1. Landing Pages
    2. Page hits
  10. Videos
    1. Video hits

Configuration

Each report can be customized to include the columns of choice. Filter data based on set criteria and/or set a specific order for the data. In addition you can also group by and select different function operators to calculate fields. Note that when you select functions operators a totals row will be added to the report. This totals row will not be exported when selecting to export a report.

The Data tab in the Edit Report window

Graphs

Some reports have graphs available. Select the graph desired from the left list - it will move to the right and will be part of the report.

The Graphs tab in the Edit Report window

Dashboard Widget

Each graph of each report is made available as a widget on the dashboard allowing complete customization of the dashboard.

The Add Widget window on the Dashboard

Scheduling Reports

Enable or disable sending reports via email by using the toggle switch.

It is possible to schedule emails which will send reports to one or more email addresses. In the To field, enter a comma-separated list of email addresses and set the frequency of sending reports by choosing day, week, or month from the drop-down list.

The Schedule tab in the Edit Report window

Since version 3.2 it is possible to send a report once. This may be helpful if the report takes some time to load. The cron job will process the request, and send the result by email.

The problem is that email attachments cannot be too large, as this could prevent them being sent. If the file is greater than 5MB (configurable file attachment limit) then the CSV file will be zipped. If the zip package is within the file attachment limit then it will be sent as an email attachment. If it is still too big the zip file will be moved to a more permanent location, and the email will contain a link to download it. The download link works only for logged in Mautic users.

If someone tries to download a compressed CSV report that had been deleted for whatever reason, Mautic will schedule the report to NOW again, and send the user the email notification when the CSV report has been created.

The one-time report export and send can be configured 2 ways:

  1. By scheduling the email: Screenshot showing the option to send the report now

  2. By a button from the report list: Screenshot shoowing option to export and send the report

The button is available only for non-scheduled reports as it would reset configuration for scheduled reports.

Cron job to schedule reports

To be able to send scheduled reports, the following cron command is required:

php /path/to/mautic/bin/console mautic:reports:scheduler [--report=ID]

The --report=ID argument allows you to specify a report by ID if required. For more information, see Cron jobs.

Found errors? Think you can improve this documentation? edit this page on Github