Skip to content

docs: Document Unsubscribe-to-Open Ratio stat for Email reports #702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promptless-for-oss wants to merge 18 commits into
base: 7.1
Choose a base branch
from
+15 −1
Open

docs: Document Unsubscribe-to-Open Ratio stat for Email reports #702

Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
25aa34a
Document Unsubscribe-to-Open Ratio stat for Email reports
promptless[bot] Mar 30, 2026
cebdc57
Sync suggestion branch with base branch
promptless[bot] Apr 1, 2026
dc128d0
Sync suggestion branch with base branch
promptless[bot] Apr 1, 2026
ceff9fc
Sync suggestion branch with base branch
promptless[bot] Apr 1, 2026
487b302
Sync suggestion branch with base branch
promptless[bot] Apr 1, 2026
ab5b67c
Sync suggestion branch with base branch
promptless[bot] Apr 2, 2026
f01022f
Sync suggestion branch with base branch
promptless[bot] Apr 2, 2026
11dbcd4
Sync suggestion branch with base branch
promptless[bot] Apr 2, 2026
51d1fb8
Sync suggestion branch with base branch
promptless[bot] Apr 3, 2026
a86f710
Sync suggestion branch with base branch
promptless[bot] Apr 3, 2026
e0f2a9f
Sync suggestion branch with base branch
promptless[bot] Apr 4, 2026
604c0a8
Sync suggestion branch with base branch
promptless[bot] Apr 11, 2026
bf48df4
Sync suggestion branch with base branch
promptless[bot] Apr 11, 2026
64a2637
Merge branch '7.1' into promptless/email-utor-stat
promptless[bot] Apr 23, 2026
3257b36
Merge branch '7.1' into promptless/email-utor-stat
promptless[bot] Apr 23, 2026
5e98113
Fix definition list style: use colon instead of dash
promptless[bot] Apr 24, 2026
4a09310
Fix admonition formatting in tip block
promptless[bot] Apr 24, 2026
a4cfc28
Move Email report columns section after Dynamic filters settings
promptless[bot] Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/reports/reports.rst
View file
Open in desktop
Copy link
Copy Markdown
Author

@promptless-for-oss promptless-for-oss Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Line 95)

Added the Unsubscribe-to-Open Ratio column description based on PR #15066 which introduces this new stat. The PR description explains it shows the percentage of unsubscribed contacts relative to opened emails.

Source: mautic/mautic#15066

Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
The parent data source provides a high-level summary of the data while the child data source provides a more granular view of Contact behavior that includes your Custom Fields and values.

* **Description - optional** - Add detailed information about the Report, helping you and other Users better understand what the Report is for. You may want to include more information about filters, people, or departments.

* **Published** - Select **Yes** to ensure that the Report is active, ready to send when scheduled in the Report options.

* **Visible for all logged-in Users** - Select **Yes** so that all Users can access the Report. If set to No, only the owner of the Report and Users with permission to view others' Reports can see the Report.
Expand All @@ -97,6 +97,20 @@
- Opened by default - If you want to ensure that the date filters and filter options for any other Report filters are visible on a Report detail page without needing to open the filters drop-down, select Yes. For example, for an Emails Report, you might want to view dynamic filters for subject or sent date.
- Hide date range - To hide the date range filter so that Users can't change the dates that the Report displays data for, select to **Yes**.

Email report columns

Check warning on line 100 in docs/reports/reports.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Report' instead of 'report'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Report' instead of 'report'.", "location": {"path": "docs/reports/reports.rst", "range": {"start": {"line": 100, "column": 7}}}, "severity": "INFO"}
--------------------

When using 'Emails' as the data source, you can add the following columns to measure Email engagement:

* **Read count:** the number of Contacts who opened the Email.
* **Unsubscribed:** the number of Contacts who unsubscribed after receiving the Email.
* **Bounced:** the number of Emails that bounced.
* **Unsubscribe-to-Open Ratio:** the percentage of unsubscribed Contacts relative to those who opened the Email. This helps you understand how Email content affects unsubscribe rates among engaged recipients.

.. tip::

Use the Unsubscribe-to-Open Ratio to compare the unsubscribe impact of different Emails. A high ratio may indicate that the Email content didn't meet recipient expectations, while a low ratio suggests it resonated with those who read it.


Data
====
Expand Down
Loading