This site is no longer being maintained. Visit the eDocs documentation portal for updated information.

Dismiss message

Query Context - Products

Created by Pedro Ondiviela · last update June 5, 2020

About this Endpoint

Returns the top specific products for a specific query. The specific product weights are calculated based on user clicks, add-to-carts and purchases and the values are normalized using a linear function.

Request URL example

GET https://api.empathybroker.com/contextsearch/v2/querycontext/products/{instance_id}?{Input_Parameters}

Input Parameters

Parameter name	Data Type
Required:
query	String
lang	String
Not required:
rows	Integer
events.min	Integer
userAttributes	String
maxTries	Integer

Responses

Responses examples for successful and failing calls to the endpoint.

“topProducts” are sorted by “weight” in descending order.

200 400 404

Successful request

Type: application/json

[
  {"value":"213115", weight:"3"},
  {"value":"213149", weight:"1.3"}
]  

Mandatory query parameter is missing

Type: application/json

{
  "code": 400,
  "error": "XXX is mandatory"
}

Either client or endpoint don’t exist

Type: application/json

{
  "code": 400,
  "error": "XXX not found"
}