Method description
Returns the top product attributes and the top specific products for a specific query. Both the attributes and specific products weights are calculated based on user clicks, add-to-carts and purchases and the values are normalized using a linear function.
"topAttributes" objects don't have a fixed order and it may change in between requests. Although, values for each attribute are sorted by "weight" in descending order.
"topProducts" are sorted by "weight" in descending order.
HTTP method
GET
URL schema
/v2/querycontext/all/{client_id}?query={query}&lang={lang}&attributes.rows={attributes.rows}&products.rows={products.rows}
Path Parameters
| Parameter name | Required | Description |
|---|---|---|
| client_id |  | Client identifier on the system |
URI Parameters
| Parameter name | Required | Description | Default |
|---|---|---|---|
| query |
| Search term that user did | |
| lang | | Language of the query | |
| attributes.rows |  | Number of values of each field | 1 |
| products.rows | | Number of products to return | 5 |
Responses
200 - successful request
Type: application/json
Example application/json
{
"topAttributes": [
{
"field": "brand",
"values": [
{"value": "apple", "weight": 3},
{"value": "sony", "weight": 1.8}
]
},
{
"field": "category",
"values": [
{"value": "mobiles", "weight": 3}
]
}
],
"topProducts": [
{"value":"213115", weight:"3"},
{"value":"213149", weight:"1.3"}
]
}
400 - mandatory query parameter is missing
Type: application/json
Example application/json
{
"code": 400,
"error": "XXX is mandatory"
}
404 - either client or endpoint don't exist
Type: application/json
Example application/json
{
"code": 404,
"error": "XXX not found"
}
Related articles
-
-
EmpathyBroker Contextualize REST API (Empathy Knowledge Base)
-
-
-
Contextualize REST API: Query Context (Empathy Knowledge Base)
-
-
Contextualize REST API: Events (Empathy Knowledge Base)
-
-
Contextualize REST API: User Context (Empathy Knowledge Base)
-