generated from readthedocs/tutorial-template
-
Notifications
You must be signed in to change notification settings - Fork 69
Add Search Section TEDU-122 #100
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.
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
Merged
RCheesley
merged 14 commits into
mautic:main
from
favour-chibueze:TEDU-122-add-search-section
Feb 22, 2023
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
816b7ce
TEDU-122
favour-chibueze cba1e0b
Merge branch 'main' into TEDU-122-add-search-section
RCheesley 901a52d
fixed vale errors and resolved suggestions
favour-chibueze 766c7b3
Merge branch 'main' of https://github.com/favour-chibueze/user-docume…
favour-chibueze b3bf6fb
Merge branch 'main' of https://github.com/favour-chibueze/user-docume…
favour-chibueze 9864afb
added pull request suggestions
favour-chibueze 085cb38
Merge branch 'main' into TEDU-122-add-search-section
favour-chibueze 6cadbd9
Merge branch 'main' into TEDU-122-add-search-section
favour-chibueze 32f1114
Merge branch 'main' into TEDU-122-add-search-section
favour-chibueze ee6d9a1
Merge branch 'main' into TEDU-122-add-search-section
favour-chibueze f6e2401
resolve suggestions
favour-chibueze 8ce51a3
Merge branch 'main' into TEDU-122-add-search-section
favour-chibueze 43b8618
Merge branch 'main' into TEDU-122-add-search-section
RCheesley 8c79b74
Merge branch 'main' into TEDU-122-add-search-section
RCheesley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,264 @@ | ||
| .. vale off | ||
|
|
||
| Search operators | ||
| Searching Mautic | ||
| ################ | ||
|
|
||
| .. vale on | ||
| .. vale on | ||
|
|
||
| Search operators and filters | ||
| **************************** | ||
|
|
||
| Mautic offers a variety of search operators and filters for drilling down into relevant resources. You can find the available search filters and operators by clicking on the button with a question mark next to the search input. | ||
|
|
||
| The search filters for that entity aren't available if such a button is missing. | ||
|
|
||
| .. image:: images/contacts-search.png | ||
| :align: center | ||
| :alt: Mautic Contact search | ||
|
|
||
| | | ||
favour-chibueze marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Mautic also has a 'global search' feature. In the top left-hand corner, click the magnifying glass icon next to the Mautic logo/notifications icon. This will open a search input where you can search across multiple different entities. | ||
|
|
||
| .. image:: images/global-search.png | ||
| :align: center | ||
| :alt: Mautic global search | ||
|
|
||
| | | ||
favour-chibueze marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Search operators | ||
| ================ | ||
|
|
||
| Here are some search operators you can use: | ||
|
|
||
| * ``+`` plus sign - Search for the exact string, for example, if you search for +admin, then administrator won't match. | ||
|
|
||
| * ``!`` exclamation mark - Not equals string | ||
|
|
||
| * ``" "`` double quotes - Search by phrase | ||
|
|
||
| * ``( )`` parentheses - Group expressions together. | ||
|
|
||
| * ``OR`` - By default the expressions joins as ``AND`` statements. Use the OR operator to change that. | ||
|
|
||
| * ``%`` - Use the % as a wildcard to search for specific names or values in a phrase for example, to find all Companies with the word ‘Technologies’ then type %technologies% | ||
|
|
||
| Search filters | ||
| ============== | ||
|
|
||
| Here are some search filters you can use: | ||
|
|
||
| Contacts | ||
| -------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| is:anonymous | ||
| is:unowned | ||
| is:mine | ||
| email:* | ||
| segment:{segment_alias} | ||
| name:* | ||
| company:* | ||
| owner:* | ||
| ip:* | ||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| common:{segment_alias} + {segment_alias} + ... | ||
| tag:* | ||
| stage:* | ||
| email_sent:EMAIL_ID | ||
| email_read:EMAIL_ID | ||
| email_queued:EMAIL_ID | ||
| email_pending:EMAIL_ID | ||
|
|
||
| Companies | ||
| --------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| category:{category alias} | ||
|
|
||
| Segments | ||
| -------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:global | ||
| name:* | ||
| category:category-alias | ||
|
|
||
| Assets | ||
| -------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:mine | ||
| is:published | ||
| is:unpublished | ||
| name:* | ||
| is:uncategorized | ||
| category:{category alias} | ||
|
|
||
| Forms | ||
| ----- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:mine | ||
| is:published | ||
| is:unpublished | ||
| has:results | ||
| name:* | ||
| is:uncategorized | ||
| category:{category alias} | ||
|
|
||
| .. vale off | ||
|
|
||
| Landing Pages | ||
| ------------- | ||
|
|
||
| .. vale on | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| is:prefcenter | ||
| category:{category alias} | ||
| lang:{lang code} | ||
|
|
||
| .. vale off | ||
|
|
||
| Dynamic Content | ||
| --------------- | ||
|
|
||
| .. vale on | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| is:prefcenter | ||
| category:{category alias} | ||
| lang:{lang code} | ||
|
|
||
| Emails | ||
| -------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| category:{category alias} | ||
| lang:{lang code} | ||
|
|
||
| Focus items | ||
| ----------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| category:{category alias} | ||
|
|
||
| Manage actions | ||
| -------------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| category:{category alias} | ||
|
|
||
| Manage triggers | ||
| --------------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| category:{category alias} | ||
|
|
||
| Stages | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| category:{category alias} | ||
|
|
||
| Reports | ||
| ------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| Categories | ||
| ids:ID1,ID2 (comma separated IDs, no spaces) is:published is:unpublished | ||
|
|
||
| Users | ||
| ----- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:admin | ||
| is:active | ||
| is:inactive | ||
| email:* | ||
| name:* | ||
| position:* | ||
| role:* | ||
| username:* | ||
| Roles | ||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:admin | ||
| name:* | ||
|
|
||
| Webhooks | ||
| -------- | ||
|
|
||
|
|
||
| .. code-block:: | ||
|
|
||
| ids:ID1,ID2 (comma separated IDs, no spaces) | ||
| is:published | ||
| is:unpublished | ||
| is:mine | ||
| is:uncategorized | ||
| is:prefcenter | ||
| category:{category alias} | ||
| lang:{lang code} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.