Sign in
Query

Query Index

Query results from index with index_id. Query index via GET is a convenience function, that offers only a limited set of parameters compared to Query Index via POST. Always use Query Index via POST for the full set of parameters and maximum flexibility. Query Index via GET is provided for simple queries and quick testing, and to be easily callable from browser address bar, but it is not intended for production use.

get/api/v1/index/{index_id}/query

Path parameters

index_idinteger required

index id

Query parameters

querystring required

query string

offsetinteger required

result offset

lengthinteger required

result length

realtimeboolean required

include uncommitted documents

enable_empty_queryboolean required

allow empty query

Headers

apikeystring required

YOUR_SECRET_API_KEY

Response

Results found, returns the SearchResultObject

timeinteger required

Time taken to execute the search query in nanoseconds

original_querystring required

Search query string

querystring required

Search query string after any automatic query correction or completion

offsetinteger required

Offset of the returned search results

lengthinteger required

Number of requested search results

countinteger required

Number of returned search results matching the query

count_totalinteger required

Total number of search results matching the query

query_termsstring[] required

Vector of search query terms. Can be used e.g. for custom highlighting.

resultsobject[] required

Vector of search result documents

facetsobject required

Facets with their values and corresponding document counts

suggestionsstring[] required

Suggestions for query correction or completion

Changes

Changed in 2 of the 11 revisions of this API.2

  • 39cce1ef7d951See the full diff
    • ○

      api operation id query_index_api_get removed and replaced with query_index_get

      api-operation-id-removed

  • 4cfd9d95648c1See the full diff
    • ○

      api operation id query_index_get removed and replaced with query_index_api_get

      api-operation-id-removed