Suggest Tracking

Track searches triggered from Suggest and send the input and session context behind them.

You can also add tracking to the FactFinder Suggest module to analyze user behavior and support optimization.

Tracking is usually already included in the example script available from FactFinder or on GitHub. If you build your own Suggest integration, add the relevant tracking parameters yourself. In both cases, it is a good idea to verify the transmitted parameters once the integration is complete.

Suggest Tracking works by adding parameters to the follow-up FactFinder query. These parameters show whether the search was triggered from a suggestion and which letters the user entered before making the selection.

Parameter

---

queryFromSuggest

This parameter indicates that the FactFinder query was triggered by a selection from the suggestion list. In that case, send the value true.

---

userInput

Use this parameter to send the letters the shop user entered before the search query was triggered.

---

sid

This parameter is required when you use the A/B Test module. If no session ID (sid) is passed to FactFinder, the search always uses variant A, because the session ID decides which A/B test variant should run.

Example

REST interface

Assume the shop user enters ri in the search box and selects Ring from the suggestion list, which then triggers a search for Ring. The FactFinder search URL with the Suggest Tracking parameters then looks like this:

rest/{apiversion}/search/{channel}?query=Ring&...&queryFromSuggest=true&userInput=ri