Skip to content

Update segment filter operator labels for Mautic 7.x #764

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 6 commits into
base: 7.2
Choose a base branch
from
Open

Update segment filter operator labels for Mautic 7.x #764

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fd99d17
Update segment filter operator labels to match Mautic 7.x UI
promptless[bot] Jun 12, 2026
2079147
Address review: format operator list and matching filters as lists
promptless[bot] Jun 15, 2026
558cc4e
Address review: consistent 'For example' formatting and example headings
promptless[bot] Jun 15, 2026
e8dbd28
Merge branch '7.2' into promptless/segment-operator-labels
adiati98 Jun 17, 2026
5ca97d5
Apply reviewer feedback: update segment operator screenshots, alt tex…
promptless[bot] Jun 17, 2026
b048892
Address review: update operator dropdown alt text and screenshot
promptless[bot] Jun 17, 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
79 changes: 45 additions & 34 deletions docs/segments/manage_segments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,39 +347,43 @@ You must ensure that you use the correct operator and time frame to build an eff

Once you've selected a date field as your filter, such as the default **Date last active** field or a custom **Birthday** field, you'll have a list of operators to choose from:

* **Equals** - The value on the Contact record exactly matches the filter value.

* **Not Equal** - The value on the Contact record is any value that doesn't match the filter value.

* **Greater than** - The value on the Contact record is at a later date in time than X date. For example, ``Greater than`` today means anytime from tomorrow until the end of time.

* **Greater than or equal** - The value on the Contact record is either at a later date in time than or including X date. For example, ``Greater than or equal`` today means anytime from today until the end of time
.. vale off

* **Less than** - The value on the Contact record is at an earlier date in time than X date. For example, ``Less than today`` means anytime from the beginning of time until yesterday.
* **Is equal to** - The value on the Contact record exactly matches the filter value.
* **Is not equal to** - The value on the Contact record is any value that doesn't match the filter value.
* **Greater than** - The value on the Contact record is at a later date in time than X date.

* **Less than or equal** - The value on the Contact record is at an earlier date in time than X date. For example, ``Less than or equal today`` means anytime from the beginning of time until today.
For example, ``Greater than`` today means anytime from tomorrow until the end of time.

* **Empty** - No value exists in the field on the Contact record.
* **Greater than or equal** - The value on the Contact record is either at a later date in time than or including X date.

* **Not empty** - A value exists in the field on the Contact record.
For example, ``Greater than or equal`` today means anytime from today until the end of time.

* **Like** - This operator isn't supported in date or date-time fields, don't use it.
* **Less than** - The value on the Contact record is at an earlier date in time than X date.

* **Not like** - This operator isn't supported in date or date-time fields, don't use it.
For example, ``Less than today`` means anytime from the beginning of time until yesterday.

* **Regexp** - Segment includes Contacts with values that match the specified regular expression pattern. If you aren't proficient with regular expression, don't use this operator.
* **Less than or equal** - The value on the Contact record is at an earlier date in time than X date.

* **Not regexp** - Segment includes Contacts with values that don't match the specified regular expression pattern. If you aren't proficient with regular expressions, don't use this operator.
For example, ``Less than or equal today`` means anytime from the beginning of time until today.

* **Is empty** - No value exists in the field on the Contact record.
* **Is not empty** - A value exists in the field on the Contact record.
* **Contains** - This operator isn't supported in date or date-time fields, don't use it.
* **Doesn't contain** - This operator isn't supported in date or date-time fields, don't use it.
* **Matches pattern** - Segment includes Contacts with values that match the specified regular expression pattern. If you aren't proficient with regular expression, don't use this operator.
* **Does not match pattern** - Segment includes Contacts with values that don't match the specified regular expression pattern. If you aren't proficient with regular expressions, don't use this operator.
* **Starts with** - Segment includes Contacts whose field values begin with the specified numbers. These filter values should generally reference years, or years and months.

*For example, A value of 19 matches any Contacts whose field value has a year in the 1900^s. A value of 200 matches Contacts with a year value between 2000 and 2009 and a value of 2020-11 matches Contacts with a field value in November 2020.*
For example, a value of 19 matches any Contacts whose field value has a year in the 1900^s. A value of 200 matches Contacts with a year value between 2000 and 2009 and a value of 2020-11 matches Contacts with a field value in November 2020.

* **Ends with** - Segment includes Contacts whose field values end with the specified numbers. These filter values should generally reference days, or months and days.

*For example, A value of 1 matches anyone whose field value is on the 1^st, 21^st, or 31^st of any month but a value of 01 matches the 1 st of a month. A value of 01-01 finds Contacts whose value is for January 1 of any year.*
For example, a value of 1 matches anyone whose field value is on the 1^st, 21^st, or 31^st of any month but a value of 01 matches the 1 st of a month. A value of 01-01 finds Contacts whose value is for January 1 of any year.

* **Contains** - Segment includes Contacts with the specified filter value anywhere in the field value.
* **In list** - Segment includes Contacts with the specified filter value anywhere in the field value.
Comment thread
adiati98 marked this conversation as resolved.

.. vale on

.. image:: images/operators-2.png

@adiati98 adiati98 Jun 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Change the image with this one.

Image

:alt: Screenshot showing Operators.

@adiati98 adiati98 Jun 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A few things here:

  • Change the image with the attached image
  • Update the alt text to be descriptive
  • Resize image by 60%
Image

Expand All @@ -393,26 +397,33 @@ Matching part of a string

.. vale on

There are 5 filters you can use for matching part of a string - ``starts with``, ``ends with``, ``contains``, ``like`` and ``regexp``.
First three filters match strings as you enter it. ``like`` filter is for advanced Users - you can specify which type you want to use with ``%`` character:
There are 5 filters you can use for matching part of a string:

* ``starts with``
* ``ends with``
* ``in list``
* ``contains``
* ``matches pattern``

The first three filters match strings as you enter them. The ``contains`` filter is for advanced Users - you can specify which type you want to use with the ``%`` character:

* ``My string%`` is the same as ``starts with`` filter with ``My string`` value.

* ``%My string`` is the same as ``ends with`` filter with ``My string`` value.

* ``%My string%`` is the same as ``contains`` filter with ``My string`` value.
* ``%My string%`` is the same as ``in list`` filter with ``My string`` value.

* ``My string`` is the same as ``contains`` filter with ``My string`` value.
* ``My string`` is the same as ``in list`` filter with ``My string`` value.

A few notes for text filters:

* You should use ``starts with``, ``ends with``, ``contains`` rather than ``like`` as they're more specific, and therefore can be more effective.
* You should use ``starts with``, ``ends with``, ``in list`` rather than ``contains`` as they're more specific, and therefore can be more effective.

* A ``%`` character in the middle of the string has no special meaning. A ``contains`` filter with ``my % string`` searches for a string with ``%`` in the middle. The same is TRUE for a ``like`` filter with ``%my % string%`` value. There is no need to escape this character.
* A ``%`` character in the middle of the string has no special meaning. An ``in list`` filter with ``my % string`` searches for a string with ``%`` in the middle. The same is TRUE for a ``contains`` filter with ``%my % string%`` value. There is no need to escape this character.

* Mautic searches for the ``%`` character in a value for the ``like`` filter, if finding at least one ``%`` Mautic doesn't perform any modification.
* Mautic searches for the ``%`` character in a value for the ``contains`` filter, if finding at least one ``%`` Mautic doesn't perform any modification.

You can use regular expressions in a ``regexp`` filter. Mautic recognises all common operators like ``|`` for OR - for example ``first string|second string``, character sets including ``[0-9]``, ``[a-z0-9]`` and so forth, repetitions (``+``, ``*``, ``?``) and more.
You can use regular expressions in a ``matches pattern`` filter. Mautic recognises all common operators like ``|`` for OR - for example ``first string|second string``, character sets including ``[0-9]``, ``[a-z0-9]`` and so forth, repetitions (``+``, ``*``, ``?``) and more.

You have to escape special characters with ``\`` if you want to use them as matching character.

Expand Down Expand Up @@ -447,11 +458,11 @@ However, you can specify much more here. Mautic recognizes relative formats too

Hour-based relative filters work with date and time fields such as **Date last active** or **Date modified**. These filters compare the full timestamp including time, not just the date portion.

Example - Consider that today is ``2022-03-05``:
**Example: consider that today is ``2022-03-05``:**

* ``Date identified equals -1 week`` returns all Contacts identified on 2022-02-26.
* ``Date identified is equal to -1 week`` returns all Contacts identified on 2022-02-26.
* ``Date identified less than -1 week`` returns all Contacts identified before 2022-02-26.
* ``Date identified equals -1 months`` returns all Contacts identified on 2022-02-05.
* ``Date identified is equal to -1 months`` returns all Contacts identified on 2022-02-05.
* ``Date identified greater or equal -1`` year returns all Contacts identified 2021-03-05 and after.
* ``Date identified greater than -1`` year returns all Contacts identified after 2021-03-05.

Expand All @@ -470,17 +481,17 @@ Beside this you can specify your date with text. These formulas are **translatab

Relative date values like ``today``, ``tomorrow``, and ``this week`` work correctly regardless of your Mautic language setting. Switching languages doesn't affect how Segments evaluate these filters.

Example (Consider that today is ``2022-03-05``):
**Example: consider that today is ``2022-03-05``:**

* ``Date identified equals last week`` returns all Contacts identified in the specified date range, for example 2022-03-01 - 2022-03-07.
* ``Date identified is equal to last week`` returns all Contacts identified in the specified date range, for example 2022-03-01 - 2022-03-07.
* ``Date identified less than last week`` returns all Contacts identified before 2022-02-22.
* ``Date identified equals last month`` returns all Contacts identified in the specified date range, for example 2022-02-01 - 2022-02-28.
* ``Date identified is equal to last month`` returns all Contacts identified in the specified date range, for example 2022-02-01 - 2022-02-28.
* ``Date identified greater or equal last year`` returns all Contacts identified 2021-01-01 and after.
* ``Date identified greater than last year`` returns all Contacts identified after 2021-12-31.
* ``Date identified greater than first day of previous month`` returns all Contacts identified after 2022-02-01.
* ``Date identified greater than last day of previous month`` returns all Contacts identified after 2022-02-28.
* ``Custom Contact date field equal birthday -1 day`` returns all Contacts identified every year on 03-04 (4th march).
* ``Custom Contact date field equal anniversary -1 month`` returns all Contacts identified every year on 02-04 (4th february)
* ``Custom Contact date field is equal to birthday -1 day`` returns all Contacts identified every year on 03-04 (4th march).
* ``Custom Contact date field is equal to anniversary -1 month`` returns all Contacts identified every year on 02-04 (4th february)

Once you have created your Segment, any applicable Contact is automatically added through the execution of a :ref:`cron job<import contacts cron job>`. This is the essence of Segments.

Expand Down
Loading