Expressions are used to perform calculations for:
- Table calculations
- Custom fields
- Custom filters
An expression is built from a combination of these elements:
- NULL: The value NULL indicates there is no data, and can be useful when you want to check that something is empty or doesn’t exist.
- A constant: A constant is an unchanging value you provide. A number such as 7 or a string such as Completed are constants.
- A field: A reference to a field, which includes dimensions, measures, and table calculations.
- An operator: There are several types of operators:
Mathematical operators (such as +, -, *, and /)
Comparison operators (such as =, >, and <=)
Logical operators (such as AND, OR, and NOT)
- A function: These are similar in nature to Excel functions, which you may already be familiar with. Functions let you transform your data or reference data in complex ways.
Creating an Expressions
Table calculations, custom fields, and custom filters use the expression editor. As you type your expression, the system prompts you with functions, operators, and field names that you might want to use.
The following sections show how to use the expression editor.
Seeing All Suggestions
Type a space to see a list of all the fields, functions, and operators that you can choose from. It’s quite a long list, so you will typically want to start typing to shorten the list to the items you’re interested in.
Adding a Field
To include a field in your expression, start typing the field’s name. As you type, the editor will narrow your search to a list of fields and functions that contain what you’ve typed. You can type the name of the field as it appears on the Explore page.
When you select a field from the list, it’s added to your expression. This ensures that all of your fields have unique names in your expression.
Adding Operators
You can add logical operators like AND, OR, and NOT to your expression if needed. Ordinarily AND operators are evaluated before OR operators, but you can override this behavior by using parentheses. You also can use comparison operators (such as >, =, and <=) and mathematical operators (such as + and *).
When your cursor is on an operator, you can check the notes that are displayed to the right of your expression in the information pane for proper use.
The other thing to keep in mind is how true and false is handled. You should use yes and no instead of true and false. These logical constants are not the same thing as the words “yes” and “no”, which are enclosed in quotes.
Adding Functions
To include a function in your expression, start typing the function’s name. As you type the editor will narrow down your search to a list of fields and functions that contain what you’ve typed.
Functions may be constructed of arguments (or variables) that require a certain type, such as a field, a number, or yes/no. When your cursor is on a function, you can check the notes that are displayed to the right of your expression in the information pane to understand which arguments you need to provide, and what type.
To see the full list of functions that is offered, see the Functions and Operators page.
You can read more detailed instructions about using functions in the section of this page called Using Functions.
Using Error Hints and the Information Pane
Note that as you type an expression, the system displays an information pane to the right. This pane provides documentation and suggestions, especially if you have an error in your expression.
As shown above, the editor provides:
- Error Highlighting: In the editor itself, the system underlines in red any parts of the expression that are not yet correct.
- Suggestions and Error Details: The top part of the information pane gives suggestions about what to add next in your expression. If there’s an error, it explains why the error is occurring. If there are multiple errors, the error that it shows to you is based on the location of your cursor.
- Documentation: In the lower part of the information pane, the system displays documentation about the function or operator you’re working with, based on your cursor position. For example, while you type the first argument of an if() function, the system provides the information that the first argument should evaluate as true or false. You can click on the function name in that section to navigate to the documentation for that function.
Including Comments
You can include comments in expressions by beginning the comment line with #:
Using Fields
Sometimes you’ll want to use the value of a field (a dimension, measure, or table calculation) in an expression. You might want to add the value of the field to something else, check that it has a certain value, include it in a function, or many other possibilities.
As described above, just type the name of the field into the expression editor, and the system will help you find the correct way to reference it. When you add a field to an expression, the system uses the field’s identifier, which looks like ${view_name.field_name}. This identifier does not always match the name of the field in the Field Picker, but it’s okay if you don’t know what it is. Just type the field name as it appears in the Field Picker and the expression editor will show you the Field Picker name and the identifier together.
There are several ways you might want to retrieve a value:
- Get a Value from the Same Row: The most basic way to use a field is to reference it directly. For example, your expression might use ${product.category}. When you do this, you’re saying “for any given row, grab the Product Category from that row.”
- Get a Value from a Different Row: You can also get a field’s value from a different row. For example, you might want the logic “for any given row, grab the Product Category from the previous row.” To do that, you can use an offset function (see a list of positional functions here). It might look like this: offset(${product.category}, -1).
- Get a Value from a Pivoted Column: You can also get values from pivoted columns. For example, you might want the logic “for any given row, grab the Total Sales from the first pivoted column.” To work with pivoted columns, you’ll need to use pivot functions (see a list of pivot functions here). It might look like this: pivot_index${alert_event.event_count}, 1).
- Get a Total from a Row or Column: If you added totals to your Explore, you can get total values from the column or row by adding :total (for column totals) or :row_total (for row totals) to the field name, using the format ${field_name:total}. For example, if you want a percentage of the total of an Alerts count, you could create a table calculation like this: ${alert_event.event_count} / ${alert_event.event_count:total}.
Using Functions
Expressions often include one or more functions, which help you to retrieve certain data or calculate certain things. They are similar in nature to Excel functions.
If you are not familiar with functions, they take the form of a name followed by two parentheses, like this: my_function(). Sometimes you’ll need to provide information within those parentheses, separated by commas. These bits of information are called “arguments” and look like this: my_function(argument_1, argument_2).
For example, the now function does not take any arguments, and gives you the current date and time. You’d use it like this: now().
In contrast, the round function does take one argument, which is a number. You’d use it like this: round(3.2). The result you would get is 3.
There are two ways to know which arguments you’ll need to provide, if any:
- The information pane that appears to the right of the expression editor will provide some documentation about the function you are writing.
- You can also navigate directly to the Functions and Operators page and look up the function you want to use.
To solidify this concept, consider the contains function which has documentation that looks like this:
| FUNCTION | SYNTAX | PURPOSE |
|---|---|---|
| contains | contains (string, search_string) | Returns Yes if string contains search_string, and No otherwise |
You can see that two arguments are required. They have the names string and search_string, but that doesn’t mean you need to type the exact word “string” and “search_string” into the function. These are just names for the arguments that you’ll replace with something. Reading the purpose, we see that string should be a field or other value we want to search in, while the search_string is the thing we want to search for. An example might be:
If the word “great” appears in the customer feedback this function will give us a result of Yes, otherwise it will give a result of No.
The final thing to know is that you can put functions inside of other functions to handle whatever complex logic you want. As long as the result of the inner function is appropriate for the arguments of the outer function, it will work. For example:
Here we’ve nested the is_null function inside of an if function, which is itself inside a contains function. It works like this:
The is_null() function checks whether or not we have customer feedback text.
Next, the if() function uses that result and returns the customer feedback text if we have it, or otherwise returns the customer comment text.
Finally, the contains() function uses the text returned by the if() function and searches it for the word “great”.
Putting it all together, logically this expression means “If we have customer feedback then search in that, but if we don’t, search in customer comments instead. In both cases, look for the word ‘great’ “.