All Collections
Reporting
People Query Builder
How do I configure the filters?
How do I configure the filters?

Describes how to edit and configure the various filters added to a query.

Updated over a week ago



Before you can configure a filter, you need to add one using the "Fields" section. See this article for more information. Added filters appear in the middle "Query" section. 

By default, the "Is Archived?" filter is added with a value of "no." Therefore, active people are returned, but you can always remove this filter if you need archived profiles as well.

Configuration

You can click on any colored underlined text to change it. The allowed values depend on the filter itself. 

Clicking on a field name will allow you to change the field. This is faster than removing the filter and adding a new one in its place. Only basic fields are available in this way. Each field has a difference configuration based on the field's data type.

There are many possibilities in how you can set the filter. In general, we tried to make it read well in English so you can get an idea of how it will work by reading it. As a reference, listed below are all the ways a filter can be configured.

String

A string field has the following structure: <field> <inequality> <value>.

Inequalities

starts with
The text for the <field> begins with <value>. Example:

does not start with
The text for <field> does not begin with <value>. Example:

ends with
The text for <field> ends with <value>. Example:

does not end with
The text for <field> does not end with <value>. Example:

contains
The text for <field> has <value> as a substring. Example:

does not contain
The text for <field> does not have <value> as a substring. Example:

is equal to
The text for <field> is exactly equal to <value>. Example:

is not equal to
The text for <field> is anything except <value>. Example:

is in list
The text for <field> is any one of the items in <value>. Items in <value> should be separated by commas. Example:

is not in list
The text for <field> is none of the items in <value>. Items in <value> should be separated by commas. Example:

is empty
The text for <field> does not have any value or is blank. Example: 

is not empty
The text for <field> has any value. Example: 

Boolean

A boolean field has the following structure: <field> <inequality>. Example:

Inequalities

is yes  
The value of <field> is "Yes" or true. Example:

is no
The value of <field> is "No" or false. Example:

Date

A date field has the following structure <field> <inequality> <parameters...> where <parameters..> depends on the selection for <inequality>.

Inequalities

is today
The value of <field> is equal to the same date the query is run. Example:

is
This inequality allows filtering for dates relative to today's date (i.e. the date the query is run). This filter is configured differently than the other date field filters. The structure is <field> is <period> <quantity> <unit> <direction> today. Examples:

is before : <parameters...> are <date>
The value of <field> is before, but not equal to <date>. Example:

is after : <parameters...> is <date>
The value of <field> is after, but not equal to <date>. Example:

is equal to : <parameters...> is <date>
The value of <field> is exactly equal to the <date> selected. Example:

is within : <parameters...> are <start_date> and <end_date>.
The value of <field> is between <start_date> and <end_date> inclusive. Example:

is not within : <parameters...> are <start_date> and <end_date>
The value of <field> is not between <start_date> and <end_date> inclusive. Example:

month is : <parameters...> is <month_name>
The month of <field> is equal to <month_name>. Example:

year is : <parameters...> is <year>
The year of <field> is equal to <year>. Example:

day of week is : <parameters...> is <weekday_name>
The day of the week <field> falls on is equal to <weekday_name>. Example:

is on a weekend
The value of <field> falls on Saturday or Sunday. Example:

is on a weekday
The value of <field> falls between Monday and Friday inclusive. Example:

is in calendar quarter : <parameters...> is <quarter>
The calendar quarter of <field> is <quarter>. Allowed values for <quarter> are Q1, Q2, Q3, and Q4. No year is used. If you want to include a year, add another filter for the same field, but for the year instead.

is empty
<field> has no value. Example:

is not empty
<field> has a value and it can be any date

A string field has the following structure:  <field> <inequality> <value>.

Inequalities

is in list
The value of <field> is at least one item in <value>. Clicking on <value> will show a list of possible values. If the field is not required, you also have the option of selecting "(Blanks)" from the list of possible values. Example:

is not in list
The value of <field> is not any item selected in <value>. Clicking on <value> will show a list of possible values. If the field is not required, you also have the option of selecting "(Blanks)" from the list of possible values. Example:

contains
The value of <field> has <value> as a substring. Clicking on <value> will show a text box where you can change the text. Example:

does not contain
The value of <field> does not have <value> as a substring. Clicking on <value> will show a text box where you can change the text. Example:

is equal to
The value of <field> is exactly equal to <value>. Clicking on <value> will show a text box where you change the text to test. Example:

is not equal to
The value of <field> is no equal to <value>. Clicking on <value> will show a text box where you can change the text to test. Example:

starts with
The value of <field> begins with <value>. Clicking on <value> will show a text box where you can change the text. Example:

does not start with
The value of <field> begins with <value>. Clicking on <value> will show a text box where you can change the text. Example:

ends with
The value of <field> ends with <value>. Clicking on <value> will show a text box where you can change the text. Example:

does not end with
The value of <field> does not ends with <value>. Clicking on <value> will show a text box where you can change the text. Example:

is empty
<field> has no value entered. Example:

is not empty
<field> has any value entered. Example:

Number

A number/currency field has the following structure: <field> <inequality> <value>. Clicking on <value> will show a text box where you can enter the number.

Inequalities

is equal to
<field> has a number exactly equal to <value>. Example:

is not equal to
<field> has a number that does not equal <value>. Example:

is between
The value of <field> is a number between <start_value> and <end_value> inclusive. Example:

is not between
The value of <field> is a number that is completely outside the range <start_value> to <end_value>. Example:

is greater than
The value of <field> is greater than (but not equal to) <value>. Example:

is less than
The value of <field> is a number that is less than (but not equal to) <value>. Example:

is greater than or equal to
The value of <field> is greater than or equal to <value>. Example:

is less than or equal to
The value of <field> is a number that is less than or equal to <value>. Example:

is empty
<field> does not have any value. Example:

is not empty
<field> has any value. Example:

Adding Custom Field Filter

You can add custom field filters when certain fields are added. When a group which contains custom fields is added, you will see an "+ add custom field" button appear to the right of the filter. The filter that appears depends on the data type of the selected custom field filter. See previous sections. Example:

Reordering Filters

You can reorder the filters by clicking and dragging the handles at the beginning of the line containing the filter. If the filter is contained in a grouping, you can only reorder it within the grouping. You cannot move it outside.

Removing a Filter

To remove a filter, hover over the filter and click on the X button at the end of the line.

To remove a grouped filter, remove all fields within the grouping.

Did this answer your question?