Advanced filtering

The advancedFilter field lets you create complex filtering expressions that combine simple operations, such as equals, prefix, and exists, by using the Boolean operators and, or, and not. Filtering applies to basic fields as well as metadata. See the advancedFilter syntax in the request example.

Supported leaf filters

Supported properties

Limits

• Filter query max depth: 10.
• Filter query max number of clauses: 100.
• and and or clauses must have at least one element (and at most 99, since each element counts towards the total clause limit, and so does the and/or clause itself).
• The property array of each leaf filter has the following limitations:
  • Number of elements in the array is 1 or 2.
  • Elements must not be null or blank.
  • Each element max length is 256 characters.
  • The property array must match one of the existing properties (static top-level property or dynamic metadata property).
• containsAll, containsAny, and in filter values array size must be in the range [1, 100].
• containsAll, containsAny, and in filter values array must contain elements of number or string type (matching the type of the given property).
• range filter must have at lest one of gt, gte, lt, lte attributes. But gt is mutually exclusive to gte, while lt is mutually exclusive to lte.
• gt, gte, lt, lte in the range filter must be of number or string type (matching the type of the given property).
• search filter value must not be blank, and the length must be in the range [1, 128], and there may be at most two search filters in the entire filter query.
• The maximum length of the value of a leaf filter that is applied to a string property is 256.

Sorting

By default, sequences are sorted by their creation time in ascending order. Sorting by another property or by several other properties can be explicitly requested via the sort field, which must contain a list of one or more sort specifications. Each sort specification indicates the property to sort on and, optionally, the order in which to sort (defaults to asc). If multiple sort specifications are supplied, the results are sorted on the first property, and those with the same value for the first property are sorted on the second property, and so on.
Partitioning is done independently of sorting; there is no guarantee of sort order between elements from different partitions.

Null values

In case the nulls field has the auto value, or the field isn't specified, null (missing) values are considered bigger than any other values. They are placed last when sorting in the asc order and first in the desc order. Otherwise, missing values are placed according to the nulls field (last or first), and their placement won't depend on the order field. Note that the number zero, empty strings, and empty lists are all considered not null.

Example

{
  "sort": [
    {
      "property" : ["createdTime"],
      "order": "desc",
      "nulls": "last"
    },
    {
      "property" : ["metadata", "<someCustomKey>"]
    }
  ]
}

Properties

You can sort on the following properties:

Limits

The sort array must contain 1 to 2 elements.