Tagging REST API: TrackClick
Overview
Endpoint to register clicks by users on search result pages.
Endpoint Name
click
Service URL
- URL_TAGGING/INSTANCE_ID/click?INPUT_PARAMETERS
Input parameters
Parameter | Description | Data Type | Mandatory |
---|---|---|---|
q | Search terms to track | String | |
title | Clicked result's title | String | |
position | TODO | Integer | |
page | Page number the product was when the user triggered the click | Integer | |
productId | ID of the product the user clicked | Integer | |
front | Front param in order to measure the performance where it does come from | String | |
url | Clicked result's url | String | |
scope | Tracking scope for this query | String | |
lang | Tracking language for this query | String | |
store | Tracking store for this query | String | |
catalog | TODO | String | |
user | User id who launched the search | String | [*] |
session | Current user's session id | String | [*] |
type | Clicked result's type (Use 4 for organic results) | Integer | [*] |
follow | If true, service returns a redirect to the url | Boolean | |
boosted | Boost descriptor (use "default" for manual boosts) | String | [**] |
boostId | Manual boost Id, required for default boosts. | String | [**] |
origin | Type of search performed, these are the possible values:
| String | |
user_type | Specifies is the user who made the request is either new, recurrent, or ignored | String | |
spellcheck | Checks whether the query has come via spellcheck or not | Boolean | |
filtered | Checks whether the query has been filtered or not | Boolean | |
contextualize | TODO | String | |
jsonCallback | Name of the callback that will be executed after the request | String | |
* This parameters are not mandatory for the service but necessary for the statistics ** If boosted value is "default" a boostId is required Additional to these parameters, when the setup begins you will be notified about additional parameters you must include in this request. This parameters should be lang, store or portal with different values. |
Output
This method returns nothing or the wrapper used as jsonCallback.
Related articles
-
EmpathyBroker Tagging REST API (Empathy Knowledge Base)
-
Tagging REST API: TrackQuery (Empathy Knowledge Base)
-
Tagging REST API: TrackClick (Empathy Knowledge Base)
-
Tagging REST API: TrackConversion [DEPRECATED] (Empathy Knowledge Base)
-
Tagging REST API: TrackAdd2cart (Empathy Knowledge Base)
-
Tagging REST API: TrackWishlist (Empathy Knowledge Base)
-
Tagging REST API: TrackAPICall (Empathy Knowledge Base)
-
Tagging REST API: TrackBrowseCategory (Empathy Knowledge Base)
-
Tagging REST API: TrackBrowseProduct (Empathy Knowledge Base)
-
Tagging REST API: TrackBrowseAdd2Cart (Empathy Knowledge Base)
-
Tagging REST API: TrackCheckout (Empathy Knowledge Base)
-
Tagging REST API: TrackBrowseCheckout (Empathy Knowledge Base)