/search/refinements

The Search Refinements API takes in 2 parameters:

navigationName: which field you wish to get more navigations against
originalQuery: the full original query that was sent, so that the correct navigations can be generated.

This will return all the available refinements, including those that could have been shown in the original query to the engine.

The area and collection to use should be defined within the originalQuery portion of the command.

Request Body

1 Example

Form data (multipart/form-data)

navigationName

string

The name of the navigation to get more refinement values for. If it is a nested field: { "navigationName": "variants.color" }

originalQuery

object

The original query sent to the search service. This must match the original query exactly in order to generate the correct refinements (that is, include all query time parameters, such as refinements, area, match strategy, and so on).

query

string

collection

string

area

string

clientKey

string

Responses

1 Example

Schema

object

string

originalRequest

object

navigation

object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

$$.env

2 variables not set

customerid

clientkey