Skip to main content
POST
Multi query items from Auto Indexing source groups

Headers

X-Api-Key
string
required

Api key to validate your environment.

Example:

"environment-1637c4d0-e878-4738-b866-152106a4f88c"

Content-Length
number
required

The length of the message body, in bytes (this header is automatically added by most clients).

Body

application/json

The query consists of a list of query objects, on the format just like when quering items in a single index, so refer to this section when looking into filters, sorting, pagination etc.

The only thing that differs with these query objects, is an addition of an sourceGroupAlias, sourceEntityType and a name fields, so you per query can define which index you want to perform the query against and also name the individual query. This means that this service can perform multiple queries on the same index, or perform queries on multiple indicies in one request, and also give you the ability to name queries for easier identification of the resulting result sets.

Note

The request payload can at most take 5 queries in one request.

Example:

Response

Valid request.

status
number
Example:

0

sourceGroupAlias
string

The source group alias which were given for the query in the request.

Example:

"erp"

sourceEntityType
string

The source entity type which were given for the query in the request.

Example:

"price"

name
string

The query name which were given for the query in the request.

Example:

"productData"

totalResults
number

The total number of results matched by query.

Example:

200

results
object[]

List of items from the index matched by the query provided.

Built in fields are prefixed with underscore (_).

facets
object[]

List of aggregated field values based on the requested facet fields.

nextPageToken
string | null

Continuation token for the next page of results. Pass this value in the pagination.nextPageToken field of the next request. null when no further results exist.

Example:

"WyIyMDI0LTAxLTAxIiwiYWJjMTIzIl0="