/
Javascript Search Library - 1.4 : querySignals

Javascript Search Library - 1.4 : querySignals

Jun 19, 2019

Overview

Instructions to use the service to retrieve different query signals data. This will involve next queries and related tags in the same endpoint.

Step-by-step guide

You can search using the querySignals function.

querySignals (term, options, callback)


Parameters

ParameterDescriptionData TypeMandatory
termsThe query typed by the userStringYes
options

Object that may contain information about filters and other required data for example: scope

ObjectNo
callbackFunction that will be executed after sending dataFunctionNo

Notes:

  • Additional parameters should be included into the options object. The list of parameters that can be included into the options parameter can be checked visiting the Search section of SEARCH REST API
  • To view the format of the JSON result, visit also the Search section of SEARCH REST API


Code samples

var options = {
    lang:'en',
	scope:'desktop'
}
    
empathySearch.querySignals('shirt', options, function(data){
    //the data object will contain top clicked
    alert('test');
});

Example of response

{
	"nextQueries": [
		{
			"query": "jeans"
		},
		{
			"query": "blouse"
		}
	],
	"relatedTags": [
		{
			"tag": "white",
			"query": "white shirt"
		},
		{
			"tag": "long sleeve",
			"query": "long sleeve shirt"
		},
		{
			"tag": "striped",
			"query": "shirt striped"
		}
	]
}