User Guide

In its simplest form, a valid query is expressed by a field name and a single term the field needs to match to. The match is case insensitive:

field:textToMatch

A single term is a single word with no whitespaces.

The wildcard * can be used to search for 0 or more characters and can be used at the beginning, at the end or at both ends of a term:

field:*matchSuffix
field:matchPrefix*
field:*matchAnywhere*

Multiple conditions can be expressed on the same field or on different fields via Boolean operators AND and OR. For example:

field:blue OR field:green

Multiple conditions can be grouped via parentheses to form sub-queries. For example:

field:blue OR (field:green AND other:red)

The following characters are reserved characters that are used for search grammar and need to be escaped when used in a term:

+ - ! ( ) { } [ ] ^ " ~ * ? : \

A field can be exactly matched to a phrase (multiple terms) by including the phrase within quotes. Wildcards are not supported with phrase matching. For example:

field:"Match a multi term phrase"

The set fields name that can be used in a search query is specific to the endpoint. The names are listed in the API specification for each endpoint.