Related Queries in Search and API

Related Queries Search

Related Queries Search Configuration

This feature is disabled by default. To enable and configure the settings with plugin search please edit the facet.js which can be found under the path <SEARCHBLOX_INSTALLATION_PATH>/webapps/ROOT/search/facet.js as below:


Set 'relatedQuery' to true.

Related Queries Search Response

As the limit is set to 5, we will get 5 related query suggestions based on indexed document content of collection(s). You can see the response in the screenshot below:


Related Queries via API

Using Related Queries API we can get related queries based on the search term used.
There are various parameters that can be configured to get the related terms to a search query. Please refer to the following section on Related Queries API

API Request




Media Type



content-type : application/json
accept: application/json



Document Syntax


Document Description

JSON AttributeDescription
apikeyAPI key accessible in the SearchBlox Admin Console. It is also present in the config.xml file.
fieldfield is the field from which the related search terms are to be fetched eg: content, keywords, title, description or custom meta field
colCollection ID
typewhether it is phrase or fuzzy search for related terms
phrase refers to exact match
fuzzy refers to fuzzy match (approximate matches)
operatorAND or OR operator between the terms if multiple words are available in search term
limitnumber of related queries returned
termsnumber of associated terms returned for each query
querysearch query
SB-PKEYSB-PKEY is an additional security key can be found for SBAdmins and Admin Users under Users Tab of Admin Console Screen.

Sample JSON Response