Skip to main content
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

DefinitionProperty TypesOperatorExamples
exact matchall=content = "hello world"
content=hello
starts withtext=^content =^ he
ends withtext=$content =$ llo
containstext=~content =~ lo
greater thanint32, int64,
float, double, decimal,
date, datetime		>count > 1
greater than or equal toint32, int64,
float, double, decimal,
date, datetime		>=content >= 1
less thanint32, int64,
float, double, decimal,
date, datetime		<count < 1
less than or equal toint32, int64,
float, double, decimal,
date, datetime		<=content <= 1
is NULLall!=*content != *
is not NULLall=*content = *
is emptytext=""content = ""
negationall!content != ”hello world”
!(content = ”hello world”)
!(content =^ “hello world”)

​
Collections (all types)

DefinitionOperatorExample
exact match with ordering=industries = [Healthcare,Fintech]
contains all=~industries =~ [Healthcare,Fintech]
empty=[]industries =[]
negation!!(industries = [Healthcare,Fintech])