diff --git a/docs/search/search_operators.rst b/docs/search/search_operators.rst index 1d2f923f..1f6ee406 100644 --- a/docs/search/search_operators.rst +++ b/docs/search/search_operators.rst @@ -58,6 +58,8 @@ Contacts search filters is:mine email:* segment:{segment_alias} + source:manually_added + source:filter_added name:* company:* owner:* @@ -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. + Companies search filters ------------------------ diff --git a/docs/segments/images/segment_contacts_stat_cards.png b/docs/segments/images/segment_contacts_stat_cards.png new file mode 100644 index 00000000..2d74ab7b Binary files /dev/null and b/docs/segments/images/segment_contacts_stat_cards.png differ diff --git a/docs/segments/manage_segments.rst b/docs/segments/manage_segments.rst index e17c8649..2e08ee9b 100644 --- a/docs/segments/manage_segments.rst +++ b/docs/segments/manage_segments.rst @@ -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. + +.. 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 *******************************