Tagging REST API: TrackBrowseCategory
Overview
Endpoint to register "category views" by users when navigating a site.
Endpoint Name
browseCategory
Service URL
URL_TAGGING/INSTANCE_ID/browseCategory?INPUT_PARAMETERS
Input parameters
Parameter | Description | Data Type | Mandatory | Defaults |
|---|---|---|---|---|
categoryId | Category ID to track | String | Yes | No |
totalHits | Number of products in this category | Integer | Yes | No |
page | Page number the user has requested | Short | Yes | No |
Common parameters | ||||
lang | Tracking language for this view | String | Yes | No |
scope | Tracking scope for this view | String | Yes | Yes |
store | Tracking store for this view | String | Yes | Yes |
catalog | Tracking catalog for this view | String | Yes | Yes |
| ||||
user | Current user ID | String | Yes | Yes |
session | Current user's session ID | String | Yes | Yes |
front | Front end identifier | String | No | - |
| ||||
filtered | Checks whether the view has been filtered or not | Boolean | No | - |
user_type | User is either new, recurrent, or ignored | String | No | - |
origin |
| String | Yes | Yes |
| ||||
jsonCallback | Name of the callback that will be executed after the request | String | No | - |
Output
This method returns nothing or the wrapper used as jsonCallback.