filters PropertiesUse the filters property to add a filter to a step query. Although you can create filters for query steps in the user interface, you have to manually define filters for static steps in the dashboard JSON.
The syntax for a filter in the step definition varies based on whether the step is in compact or SAQL form. This section describes the filter syntax for compact-form steps, including a description and example of every operator. For information about the filters for SAQL-form steps, see the Analytics SAQL Developer Guide.
Filters defined in compact-form steps have the following syntax.
1"filters": [[
2 "field",
3 [value],
4 "operator"
5]]For example, the following filter shows only records where Sales is between 1 and 100,000 and Customer_Segment is either Consumer or Corporate.
1"filters": [
2 [
3 "Sales",
4 [
5 1,
6 100000
7 ],
8 ">=<="
9 ],
10 [
11 "Customer_Segment",
12 [
13 "Consumer"
14 "Corporate"
15 ],
16 "in"
17 ]
18]]1"filters": [Region", ["East", "West"], "in"]
2 "filters": [Region", ["st"], "matches"]
3 "filters": [Region", [], "isnull"]
4 "filters": [["year", "OrderDate"], [2020, 2022], "in"]1"filters": ["Profit", [], "isnull"]
2 "filters": ["Profit", [1], ">="]
3 "filters": ["Profit", [1, 100], ">=<="]1"filters": ["OrderDate", ["2019-10-12", "2019-10-22"], "between"
2 "filters": ["OrderDate", ["2019-10-12", null], "between"]
3 "filters": ["OrderDate", [null, "2019-10-22"], "between"]1"filters": ["OrderDate", [[fiscal_year", -1], ["day", 0]], "between"]]"between"]1"filters": [
2 [
3 [
4 "Type",
5 "LeadSource"
6 ],
7 [
8 "Existing Business",
9 "Advertisement"
10 ],
11 "in"
12 ]
13 [
14 [
15 ["year", "CloseDate"],
16 ["quarter", "CloseDate"]
17 ],
18 [
19 [2020, 2],
20 [2021, 3]
21 ],
22 "in"
23 ]
24]Filters defined in compact-form steps have the following syntax.
1"filters": [[
2 "field",
3 [value],
4 "operator"
5]]For example, the following filter shows only records with a “Customer” account type.
1"filters": [[
2 "Account_Type",
3 ["Customer"],
4 "in"
5]]To compare against multiple values, include the values in an array, like this.
1"filters": [[
2 "field",
3 [[value1, value2, value3]],
4 "operator"
5]]To specify an absolute date value for a date filter, specify the value in epoch format, where the value is the number of milliseconds since January 1, 1970 midnight UTC (1970-01-01 00:00:00). The following example shows dataset rows with a close date on or before January 1, 2016.
1"filters": [[
2 "Close Date",
3 [[
4 1451606400000,
5 null
6 ]],
7 ">="
8]]You can use different operators in a filter. The supported operators depend on the field type. If you don’t specify the operator, Analytics applies the == operator.
| Operator | Description | Compact-Form 2.0 Example | Compact-Form 1.0 Example | |
|---|---|---|---|---|
in | Value of dataset field equals one of the specified values. Applies to dimensions only. | ["Dimension",["Value1","Value2"],"in"] | ["Dimension",["Value1","Value2"],"in"] | |
not in | Value of dataset field is not in the specified list of values. Applies to dimensions only. | ["Dimension",["Value1","Value2"],"not in"] | ["Dimension",["Value1","Value2"],"not in"] | |
matches | Value of dataset field contains the specified value. This operator is not case-sensitive. Applies to dimensions only. | ["Dimension",["Val"],"matches"] | ["Dimension",["Val"],"matches"] | |
is null | Value of dataset field is null. Applies to measures, dimensions and absolute dates in Compact form 2.0 and to measures only in Compact form 1.0. | ["Measure",[],"isnull"] | ["Measure",[[]],"isnull"] | |
is not null | Value of dataset field is not null. Applies to measures, dimensions and absolute dates in Compact form 2.0 and to measures only in Compact form 1.0. | ["Measure",[],"isnotnull"] | ["Measure",[[]],"isnotnull"] | |
== | Value of dataset field equals the specified value. Applies to measures only. | ["Measure",[1],"=="] | ["Measure",[[1]],"=="] | |
!= | Value of dataset field does not equal the specified value. Applies to measures only. | ["Measure",[1],"!="] | ["Measure",[[1]],"!="] | |
< | Value of dataset field is less than the specified value. Applies to measures only. | ["Measure",[10],"<"] | ["Measure",[[10]],"<"] | |
> | Value of dataset field is greater than the specified value. Applies to measures only. | ["Measure",[1],">"] | ["Measure",[[1]],">"] | |
<= | Value of dataset field is less than or equal to the specified value. Applies to measures only in Compact form 2.0 and to measures and absolute dates only in Compact form 1.0. | ["Measure",[10],"<="] |
| |
>= | Value of dataset field is greater than or equal to the specified value. Applies to measures only in Compact form 2.0 and to measures and absolute dates only in Compact form 1.0. | ["Measure",[1],">="] |
| |
>=<= or between with measures and dates in Compact form 1.0 | Value of dataset field is between the specified values, inclusive. For relative dates, you can specify the following time periods: “year”, “quarter”, “month”, “week”, and “day”. Applies to measures only in Compact form 2.0 and measures and dates only in Compact form 1.0. You can also use these operators with measures in Compact form 2.0 and measures and dates in Compact form 1.0:
| ["Measure",[1,10],">=<="] |
| |
between with dates in Compact form 2.0 | Value of dataset field is between the specified values, inclusive. For relative dates, you can specify the following time periods: “year”, “quarter”, “month”, “week”, and “day”. |
|
To view a complete example with a binding syntax, see the Bind the Initial Filter Selection documentation.
j