Tagging REST API: TrackClick


Endpoint to register clicks by users on search result pages. 

Endpoint Name


Service URL


Input parameters

ParameterDescriptionData TypeMandatory
qSearch terms to trackString(tick)
titleClicked result's titleString(tick)
positionTODO (question)Integer(error)
pagePage number the product was when the user triggered the clickInteger(tick)
productIdID of the product the user clickedInteger(error)
frontFront param in order to measure the performance where it does come fromString(error)
urlClicked result's urlString(tick)
scopeTracking scope for this queryString(tick)
langTracking language for this queryString(tick)
storeTracking store for this queryString(tick)
catalogTODO (question)String(tick)
userUser id who launched the searchString(error) [*]
sessionCurrent user's session idString(error) [*]
typeClicked result's type (Use 4 for organic results)Integer(error) [*]
followIf true, service returns a redirect to the urlBoolean(error)
boostedBoost descriptor (use "default" for manual boosts)String(error) [**]
boostIdManual boost Id, required for default boosts.String(error) [**]

Type of search performed, these are the possible values:

  • default : common search without help of any feature.
  • empathize_category, empathize_term,

    empathize_reference, empathize_recommendations, empathize_next_queries, empathize_trending: search using empathize (suggestions etc)

  • linked : redirected searches
  • partial : new search with origin in a suggestion in a non results query
  • next_query, next_query_grid : search by selecting a next_query
  • related_tag : search by selecting a related tag
  • history: search by selecting a term in the history

  • spellcheck: search with spellcheck

user_typeSpecifies is the user who made the request is either new, recurrent, or ignoredString(error)
spellcheckChecks whether the query has come via spellcheck or notBoolean(error)
filteredChecks whether the query has been filtered or notBoolean(error)
contextualizeTODO (question)String(error)
jsonCallbackName of the callback that will be executed after the requestString(error)

* 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.


This method returns nothing or the wrapper used as jsonCallback.