Overview
Instructions to send clicks information using the Javascript Tagging Library.
Step-by-step guide
Clicks can be sent to the dashboard using the functions trackClick / trackClicks.
trackClick
| Code Block |
|---|
|
trackClick(terms, page, title, url, scope, options, callback) |
Parameters
| Parameter | Description | Data Type | Mandatory |
|---|
| terms | The query typed by the user | String | Yes |
| page | The page number | Integer | Yes |
| title | The product or result title | String | Yes |
| url | Destination URL, for example product detail page | String | Yes |
| scope | This parameter is used for separate analytic data between two or more different scenarios | String | No* |
| options | Object that may contain information about filters and other required data | Object | No |
| callback | Function that will be executed after sending data | Function | No |
*This parameters are not mandatory for the service but necessary for the statistics |
...
NOTE: The values for scope and options parameters will be provided by the EmpathyBroker Team.
Code samples
| Code Block |
|---|
|
<a href="http://MY_PRODUCT_URL.com" title="My product title" class="myLink">My Test Link</a> |
| Code Block |
|---|
|
/**
* 1 -> Capture click on the desired product
* 2 -> Avoid default action (redirect to destination url)
* 3 -> Execute trackClick function with the desired callback (including url redirection)
*/
jQuery('a#myLink').click(function(){
event.preventDefault();
var myURL = this.href;
var title = this.title;
empathyTAG.trackClick('test',1,this.title,this.href,'testscope',{lang:'en'},function(){
//Add your code here
document.location.href = myURL;
});
}); |
trackClicks
Same behavior as trackClick but this function allow to execute the tagging over a set of elements using DOM selectors.
| Code Block |
|---|
|
trackClicks(selectors, terms, page, scope, options, callback) |
Parameters
| Parameter | Description | Data Type | Mandatory |
|---|
| selectors | One or more selectors (using any framework you want) pointing to the html elements to be tracked | Array of DOM selectors | Yes |
| terms | The query typed by the user | String | Yes |
| page | The page number | Integer | Yes |
| scope | This parameter is used for separate analytic data between two or more different scenarios | String | No* |
| options | Object that may contain information about filters and other required data | Object | No |
| callback | Function that will be executed after sending data | Function | No |
*This parameters are not mandatory for the service but necessary for the statistics |
...
NOTE: The values for scope and options parameters will be provided by the EmpathyBroker Team.
Code samples
| Code Block |
|---|
|
<a href="http://MY_PRODUCT_URL.com" title="My product title" class="myLink">My Test Link</a>
<a href="http://MY_PRODUCT_URL_2.com" title="Other product title" class="myLink2">Other test link</a> |
...
| Code Block |
|---|
|
var selectors = [jQuery('a.myLink'),jQuery('a.myLink2')];
empathyTAG.trackClicks(selectors, 'test', 1, 'testscope',{lang:'en'}, function(responseData){}); |
Related articles
| Filter by label (Content by label) |
|---|
| cql | label = "empathy-tag-api-javascript" and space = currentSpace() |
|---|
|