Tagging REST API: TrackClick

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

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:

  • 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

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