Overview
The purpose of this guide is to provide the steps required to integrate search service via REST API and use the returned tagging urls for each event (query, click, add2cart, ...).
Service URL
EMPATHYBROKER_BASE_URL/search/v1/query/CLIENT_ID/search?URI_PARAMETERS
Note: remember to request your CLIENT_ID and proper EMPATHYBROKER_BASE_URL
URI Parameters
| Parameter Name | Scope | Description | Type | Mandatory | Default Value |
|---|---|---|---|---|---|
| q | search | The query for the request | String |  | |
| lang | search & tagging | Set the language used on this request | String | | |
| session | search & tagging | Set the session used on this request | String | | |
| user | search & tagging | Set the user used on this request | String | | |
| scope | search & tagging | Set the scope used on this request | String | | |
| start | search | The number of results to omit from the start of the result set (search pagination) | Integer |  | 0 |
| rows | search | Number of results to return (search pagination) | Integer | | 10 |
| filter | search | Set query filters to apply | String | | |
| facet | search | Set query facets to return | String | | |
| sort | search | Sort results | String | | |
| jsonCallback | search | Name of the callback that will be executed after the request | String | | |
| suggestions | search | Number of results to include for each suggestion | String | |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
facets: [
{
facet: "brand",
values: [
{
value: "samsung",
count: 13,
filter: "brand:samsung"
},
{
value: "fitbit",
count: 1,
filter: "brand:fitbit"
}
]
}
] |
...
The search engine can detect grammatical errors and automatically correct it, for example searching by "sammsung" the system will suggest "samsung" in the spellchecked node.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
content: {
numFound: 2,
docs: [],
facets: [],
spellchecked: "samsung"
},
topTrends: [],
ebTagging: {
query: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/query?q=QUERY&scope=default&lang=es&totalHits=10&page=1"
}
} |
...
For example searching by "samsung panasonic" the search engine detects than there're no products with both terms but there are products with each term separately.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
content: {
suggestions: [
{
suggestion: "panasonic",
numFound: 101,
docs: [
{
name: "Panasonic KX-TG 8621",
[... more fields ...]
ebTagging: {
click: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/click?q=QUERY&scope=default&lang=es&url=PRODUCT_URL&page=1&productId=PRODUCT_ID&title=PRODUCT_NAME&type=4",
add2cart: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/add2cart?q=QUERY&scope=default&lang=es&url=PRODUCT_URL&page=1&productId=PRODUCT_ID&title=PRODUCT_NAME&type=4",
wishlist: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/wishlist?q=QUERY&scope=default&lang=es&url=PRODUCT_URL&page=1&productId=PRODUCT_ID&title=PRODUCT_NAME&type=4",
conversion: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/conversion?q=QUERY&scope=default&lang=es&url=PRODUCT_URL&page=1&productId=PRODUCT_ID&title=PRODUCT_NAME&type=4"
}
},
{
name: "Panasonic KX-TGP 550",
[... more fields ...]
ebTagging: {
click: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/click?q=QUERY&scope=default&lang=es&url=PRODUCT_URL&page=1&productId=PRODUCT_ID&title=PRODUCT_NAME&type=4",
add2cart: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/add2cart?q=QUERY&scope=default&lang=es&url=PRODUCT_URL&page=1&productId=PRODUCT_ID&title=PRODUCT_NAME&type=4",
wishlist: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/wishlist?q=QUERY&scope=default&lang=es&url=PRODUCT_URL&page=1&productId=PRODUCT_ID&title=PRODUCT_NAME&type=4",
conversion: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/conversion?q=QUERY&scope=default&lang=es&url=PRODUCT_URL&page=1&productId=PRODUCT_ID&title=PRODUCT_NAME&type=4"
}
}
]
},
{
suggestion: "samsung",
numFound: 14,
docs: [
{
name: "Samsung Galaxy Note 10.1",
[... more fields ...]
ebTagging: {
...
}
},
{
name: "Samsung SNH-1010N Smartcam",
[... more fields ...]
ebTagging: {
...
}
}
]
}
]
},
topTrends: [],
ebTagging: {
query: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/query?q=QUERY&scope=default&lang=es&totalHits=10&page=1"
}
} |
...