Skip to main content
GET
Search properties
Check our extensive examples and description here.
You can add &view=html to your querystring and we will render an html page with explanations.

Authorizations

x-api-key
string
header
required

Query Parameters

q
string
required

The query string use * for all

Minimum string length: 1
query_by
string
required

Query by field, for supported fields see documentation

filter_by
string

Filter by, for supported fields see documentation

sort_by
string

Sort by, for supported fields see documentation

view
string

Set to html if you want to render the search result to webpage

Response

200 - application/json

The search response

facet_counts
object[] | null
found
integer<int32>
hits
object[] | null
grouped_hits
object
out_of
integer<int32>
page
integer<int32>
request_params
object
search_cutoff
boolean | null
search_time_ms
integer<int32>