Filters is a way to segment users. This function allows you to get information about end users for the purpose of either contacting them outside of the chatbot or asking for their permission to push content to them from the bot. You can use the Broadcasting Tool to push content from your bot by using Filters.
Filters can be found within the Section menu on the left side of the Navigation bar, which drops down when you hover over the grid symbol. Below, we'll go over two key points:
How to create a Filter
To create a Filter, you will first have to name it. Make sure the name is one you will recognize, so you can easily find it again.
You should also set the criteria for the Filter. To do so, you will have to choose from a list of keys, which are as follows:
- Bot ID: This key will always have to be chosen, as it decides which bot the Filter applies to.
- Created date: This key refers to the time when the user first interacted with the bot. When a user first interacts with a bot, they will get an ID.
- Create date days ago: You can set a specific number of days from a user’s creation and use this information to reach out to them. This can, for example, be seven days after a user was created.
- Message content: This is if you want to Filter users based on their input from anywhere in the chat.
- Message’s module ID: This will Filter users who have been through a certain Module.
- Message in: This key is if you want to Filter users based on their input in a specific Module.
- Custom variable: This Filter is based on Custom Variables.
In most of the keys above, you will have to select a comparison for them. You have the following comparisons to choose from:
- Equal symbol: This is if your key's value should be considered the same as what it is compared to.
- Greater than symbol: If you want the key’s value to be greater than what it is compared to.
- Less than symbol: If you want the key’s value to be less than what it is being compared to.
- Greater than or equal to symbol: This means that what is being compared should either be greater than or equal to the key’s value.
- Less than or equal to symbol: This means that what is being compared should either be less than or equal to the key’s value.
- Regexp: This recognizes words like “Yes, please” and detects when any of “Yes”, “Please”, or “Yes, please” have been used in sentences.
Now, you may be wondering what your keys should be compared to. These are often determined by the key that you have chosen. So, if you want to Filter based on a specific bot, then you will only be able to choose between the bots attached to your account.
After creating one criterion, you can always add more criteria to your Filter by using the “and” and “or” buttons.
How to view a Filter
In your overview of Filters, you will be able to see the Filter’s UUID, which is needed if you want to use a Broadcasting Tool for pushing content to your users. You will also see your company name, the name of the Filter, a description of the Filter, and the date it was created.
You can copy all of these if you hover your mouse over the specific cell. If you do not need all of this information, then you can easily remove them by pressing “Columns” and clicking on the detail(s) you do not wish to see.
Clicking "Edit" will allow you to edit the Filter from this view, where you can add or remove criteria from an existing Filter. This has the exact same layout as when you create a new Filter.
When you "View" the filter, you can see the data gathered about your end users based on the Filter’s criteria. The data contains both freely written input from end users, but also the suggested replies that they have chosen.
If you no longer want to use a specific Filter, you can simply press “Delete”.
Note that you can export this data from the Codemonkey Platform in a CSV file.