Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

Overview

Instructions to send browse information using the Javascript Tagging Library.

Step-by-step guide

Browsing data can be sent to Empathy using the trackBrowseCategory function including the parameters detailed below. This function should be executed each time a product category page is loaded.

Code Block
languagejs
trackBrowseCategory( categoryid, results, page, options, callback)


Parameters

ParameterDescriptionData TypeMandatory
categoryidThe ID of the Product Category Page loadedStringYes
resultsNumber of results displayed in the categoryIntegerYes
pageThe page numberIntegerYes
optionsObject that may contain information about filters and other data like session and userIDObjectNo*
callbackFunction that will be executed after sending dataFunctionNo

*This parameters are not mandatory for the service but necessary for the statistics

Options

The options object should contains additional parameters not passed as parameters in function call:

...

Code Block
languagejs
{
	categoryId: categoryid,
    totalHits: results,
    page: page,
    scope: scope,
    referrer: document.referrer
}

Code samples

Normal Usage

Specifying a callback parameter
Code Block
languagejs
/**
 * This example suppose that the provided scope is 'testscope' and the parameter to be included in the options parameter is the lang
 * parameter with value 'en' . UserID and SessionID are also included.
 **/

var options = {
    lang:'en',
	session: 'q1w2e3r4t5y6',
	scope: 'testscope',
	user: 'u1s2e3r',
}

empathyTAG.trackBrowseCategory('myCatID', 48, 1, options,function(responseData){
    alert('test');
});
Without a callback (No functions will be executed after tracking the data)
Code Block
languagejs
/**
 * This example suppose that the provided scope is 'testscope' and the parameter to be included in the options parameter is the lang
 * parameter with value 'en' . UserID and SessionID are also included.
 **/

var options = {
    lang:'en',
	session: 'q1w2e3r4t5y6',
	scope: 'testscope',
	user: 'u1s2e3r',
}

empathyTAG.trackBrowseCategory('myCatID', 48, 1, options);

Best practices

In most of the cases, you should implement one of these solutions to prevent receiving partial queries:

...

  • Blank queries: Do not send a category without characters. Usually when users click in search button without write nothing in search box.

    • In this case be careful to not send the placeholder text (i.e. "Search...")

Filter by label (Content by label)
cqllabel = "empathy-tag-api-javascript" and space = currentSpace ( )