Following the standard Filter Operators, you can define multivalued filter operators by specifying a list of items and the associated operator. The format has the following syntax:
- Key: A mandatory field that identifies the specific attribute or property to filter.
- Operator: An optional field that defaults to $eq (equal) if not specified. The available operators for multivalued comparisons are:
- $in: In
- $nin: Not In
- Value: This field specifies the list of values to be used in the comparison. You can provide a single item or an array of string or numeric elements.
Then, each filter has the following format:
{
"key": string, // mandatory
"operator": string, /* optional for multivalued are $in or $nin*/
"value": string | number | [string|number]
}
Suppose you want to retrieve information about products within a list of quarters. You can define a filter using the following structure:
"filters": [
{
"key": "quarters",
"operator": "$in",
"value": "[\"q1\",\"q2\",\"q3\"]"
}
]
To retrieve information that excludes a list of tags and corresponds to a list of years, you can combine two filters as follows:
"filters": [
{"key": "years", "operator":"$in", "value":"[2023,2024,2025]"},
{"key": "tags", "operator": "$nin", "value": "[\"tagId01\",\"tagId02\",\"tagId03\"]"}
]
Available for:
Since version 2025-07.