Skip to content

Document Segment detail stat cards and source: contact search filter #786

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 3 commits into
base: 7.2
Choose a base branch
from
+28 −0
Open

Document Segment detail stat cards and source: contact search filter #786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9922b37
Document Segment detail stat cards and source: contact search filter
promptless[bot] Jun 23, 2026
9fda9fe
Apply review feedback: stat-card wording and add stat cards image
promptless[bot] Jun 25, 2026
9eb31c7
Address Vale FeatureList warning: capitalize Contacts in stat-cards i…
promptless[bot] Jul 8, 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
6 changes: 6 additions & 0 deletions docs/search/search_operators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ Contacts search filters
is:mine
email:*
segment:{segment_alias}
source:manually_added
source:filter_added
name:*
company:*
owner:*
Expand All @@ -71,6 +73,10 @@ Contacts search filters
email_queued:EMAIL_ID
email_pending:EMAIL_ID

.. note::

Combine the ``source:`` filter with the ``segment:`` filter to break down a Segment's membership by how Contacts joined it. ``source:manually_added`` returns Contacts added manually, including those who subscribed through the Preference Center, and ``source:filter_added`` returns Contacts that Mautic added automatically based on the Segment's filter rules. On its own, without a ``segment:`` filter, ``source:`` returns no results.

@promptless-for-oss promptless-for-oss Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Documented the source:manually_added / source:filter_added contact search filters from PR #16350. The source: command handling in LeadRepository::addSearchCommandWhereClause shows it scopes to the active segment: context and returns no results when no segment is in the query, and the user-facing description string mautic.lead.lead.searchcommand.source.description in Translations/en_US/messages.ini states "Use together with segment:alias. Valid values: manually_added, filter_added".

Source: mautic/mautic#16350


Companies search filters
------------------------

Expand Down
Binary file added docs/segments/images/segment_contacts_stat_cards.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/segments/manage_segments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,28 @@ When viewing all Segments, the **# contacts** column shows the number of Contact

.. vale off

Viewing a Segment's statistics
******************************

.. vale on

When you open a Segment, the detail view shows a row of stat cards that summarize its membership. Each card shows a count and links to the Contacts interface filtered to those Contacts.

@promptless-for-oss promptless-for-oss Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Documented the Segment detail stat cards from PR #16350. The card set and the filter-only Filter added contacts card come from List/details.html.twig (segmentCards built with the list.filters is not empty guard), and the descriptions of the Manually added contacts and Filter added contacts cards come from the tooltip strings mautic.lead.segments.manually.added.contacts.tooltip and mautic.lead.segments.filter.added.contacts.tooltip in Translations/en_US/messages.ini.

Source: mautic/mautic#16350


.. image:: images/segment_contacts_stat_cards.png
:width: 700
:alt: Segment detail view showing four stat cards - Total, Active, Manually added, and Filter added - each with a count of Contacts.

.. vale off

* **Total contacts** - All Contacts in the Segment.
* **Active contacts** - Contacts in the Segment who aren't marked as Do Not Contact.
* **Manually added contacts** - Contacts added manually to the Segment. This includes Contacts a Mautic User added directly and Contacts who subscribed through the Preference Center.
* **Filter added contacts** - Contacts that Mautic added automatically based on the Segment's filter rules. This card appears only for Segments that have filters configured.

.. vale on

.. vale off

Exporting Contacts of a Segment
*******************************

Expand Down
Loading