Overview
...
The purpose of this guide is to provide the steps required to integrate browse service via REST API and use the returned tagging urls for each event (query, click, add2cart, ...).
Step-by-step guide
Service Name
...
| Parameter | Description | Data Type | Mandatory |
|---|---|---|---|
| categoryId | The query for the requestcategory that has been clicked to filter by | String | Yes |
| lang | Set the language of the query | String | Yes |
| start | It is used to paginate results from a query | Integer | Yes |
| rows | It is used to paginate results from a query | Integer | Yes |
| filter | Set query filters | String | No |
| boost | boosting query in lucene query format | String | No |
| facet | Set query facets | String | No |
| sort | Sort results | String | No |
| jsonCallback | Name of the callback that will be executed after the request | String | No |
...
By default, the service will return one node for the search results (content).
Moreover this JSON includes one node per product with the tagging urls and one additional node with the search tagging url.
| Code Block | ||
|---|---|---|
| ||
{
content: {},
ebTagging: {
browseCategory: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/browseCategory?categoryId=QUERY&scope=default&lang=es&totalHits=10&page=1...."
}
} |
...
- numFound → number of the documents returned by the service
- docs → Json array with the documents returned by the service. Each one will contain all the fields configured to be returned by the search service.
- facets → filters, will contain one entry for each facet contained in the request using the facets param or directly configured in the search service by the EB Team.
- ebTagging.querybrowseCategory → URL to send the query associated tagging event to our tagging service.
...