Filtering

Some endpoints support a filtering language for flexible and powerful queries. This allows for the creation of complex filter expressions using different operators and boolean logic in a single filter string. The description of each endpoint will contain information on which filter properties and operators are supported.

​

Rules

• Spaces are insignificant by default. For example, field = hello and field=hello are both valid.
• If spaces are significant, they need to be inside double quotes, for example, field = "hello world"
• Special characters need to be escaped with a backslash: field="hello\" world".
  Full list of special characters: \ * ~ ! & = > < $ ^ | " ' ( ) ] [ /
• Use & and | for boolean operations: foo = 1 | baz = 2 & bar = 3. Boolean Algebra Logic is assumed: & takes precedence over |. When evaluating the condition above, baz = 2 & bar = 3 will be computed first, and then the result will be or’ed with foo=1
• Parentheses can be used to specify the order of operations. In the example above, to make sure that foo = 1 | baz = 2 is evaluated first, parentheses must be placed (foo = 1 | baz = 2) & bar = 3

​

Grammar

​

Simple Types

​

Collections (all types)