What is this?

Admin note: This is the search and filtering language used throughout the platform. It allows you to create specific rules to find exactly the records you are looking for, whether you’re searching for products, orders, or customers.

Who is this for? Administrators should read this to understand how to build complex search rules in the application’s interface. While it looks like code, it’s designed to be human-readable. Developers will also use this syntax when building automated workflows or custom integrations.

Key benefits for the e-shop:

• Precise Search: Find exactly what you need by combining multiple conditions (e.g., “all active products in the Electronics category priced over $100”).
• Business Rules: Create automated rules based on your data (e.g., “flag all orders from last month that are still pending”).
• Language-Specific Search: Easily find products that are missing translations in specific languages like English or German.
• Smart Analytics: Use advanced math and date rules to filter your data for deep business insights.

Filter System

Our Filter System provides a powerful, human-readable language for filtering entities and their relations. It works seamlessly across the entire platform - in the application UI, the query system, and REST APIs.

Choose a Topic

Explore different parts of the filter system to find exactly what you need.

card: Basic Filtering
[navigate:where-basics.md|Basics|filter]
Equality, comparisons, null checks, and logical operators.
card: Advanced Filtering
[navigate:where-advanced.md|Advanced|database]
Relation filtering, hierarchical subtrees, and multi-language support.
card: Functions & Aggregation
[navigate:where-functions.md|Functions|zap]
Date manipulation, string transformations, and cross-relation calculations.
card: Practical Examples
[navigate:where-examples.md|Recipes|shopping-cart]
Real-world recipes for e-shop admins and common use cases.

Universal Usage

• Application UI: Double-click any filter text to edit the raw syntax directly.
• AI-Assisted: Use AI Chat to help design complex filters in natural language.
• API Integration: Use the same syntax in the where parameter of the Query System or the filter parameter of REST endpoints.
• Changeset Compatible: Works with historical data and point-in-time queries through changeset integration.

Quick Reference Table