Create an advanced query
This guide shows you how to create an advanced Query Builder query from scratch, shape the results using query operations, and save the query.
Preview
Query Builder is in preview. Features and functionality may change.
Before you start
Before starting, confirm you have:
- Access to Illuminate in the Admin Portal.
- At least one Business Object. An active Business Object shows data immediately. An inactive one shows no data until activated.
For an overview of advanced queries, query operations, and how queries connect to Decisions, see Query Builder.
Configure the query
- In the Admin Portal, go to Illuminate > Business Objects.
- At the top of the Business Objects page, click New query, then click Create advanced query.
- Enter a name for your query. Add an optional description.
- Click Select Business Object and choose a Business Object from the list. If the Business Object is not yet activated, the query returns no data.
- Set the default limits:
- Period: how far back in time the query looks at data from the Business Object. An advanced Query Builder query looks back 1 hour by default, up to a maximum of 1 day.
- Maximum rows: the maximum number of rows the query returns. An advanced Query Builder query returns at most 500 rows.
- Optionally, click Run to preview the raw data before adding operations.
Add query operations
Operations shape and refine the data the query returns. You can chain multiple operations.
- Click Add to query.
- Select an operation from the list.
- Configure the operation using the options that appear.
- Repeat to add more operations.
Available operations:
| Operation | What it does |
|---|---|
| Aggregation | Calculates a summary value: average, count, count distinct, sum, min, or max |
| Filter | Narrows results to rows that match specific criteria |
| Group By | Groups rows sharing the same field value so aggregations apply per group |
| Sort By | Orders results by a chosen field in ascending or descending order |
| Selection | Returns only specified fields instead of all available fields |
Save the query
- Click Save to store your query configuration.
After saving, you can click Run to execute the query and review results. Each row represents a condition that can trigger an action when you connect the query to a Decision. See Create a Decision from a query.