Tagging REST API: TrackQuery

Owned by David Argüello Sánchez
Last updated: Nov 19, 2019 by Ana González García
1 min read

Overview

Endpoint used to register queries launched by the users. 

Endpoint Name

query

Service URL

URL_TAGGING/INSTANCE_ID/query?INPUT_PARAMETERS

Input parameters

ParameterDescriptionData TypeMandatory
qSearch terms to trackStringYes
totalHitsNumber of total results for these search termsIntegerYes
referrerSERP referrer urlStringYes
scopeTracking scope for this queryStringYes
langTracking language for this queryStringYes
storeTracking store for this queryStringYes
userUser id who launched the searchStringNo*
sessionCurrent user's session idStringNo*
pagePage number the user has requestedShortYes
origin

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

StringNo
boostedBoost descriptor (use "default" for manual boosts)StringNo**
boostIdManual boost Id, required for default boostsStringNo**
jsonCallbackName of the callback that will be executed after the requestShortNo

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