Versions Compared

Key

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

Overview

The purpose of this guide is to provide the steps required to integrate search service via REST API and use the returned tagging urls for each event (query, click, add2cart, ...).

Service URL

EMPATHYBROKERURL_BASE_URL/search/v1/query/CLIENTSEARCH/INSTANCE_ID/search?URIINPUT_PARAMETERSNote: remember to request your CLIENT_ID and proper EMPATHYBROKER_BASE_URL

URI Parameters

Parameter NameScopeDescriptionTypeMandatoryDefault Value
qsearchThe query for the requestString(tick)
langsearch & taggingSet the language used on this requestString(tick)
sessionsearch & taggingSet the session used on this requestString(tick)
usersearch & taggingSet the user used on this requestString(tick)
scopesearch & taggingSet the scope used on this requestString(tick)
origintaggingSet the origin of the request (default, GA, partials, ...)String(error)
startsearchThe number of results to omit from the start of the result set (search pagination)Integer(error)0
rowssearchNumber of results to return (search pagination)Integer(error)10
filtersearchSet query filters to applyString(error)
facetsearchSet query facets to returnString(error)
sortsearchSort resultsString(error)
jsonCallbacksearchName of the callback that will be executed after the requestString(error)
suggestionssearchNumber of results to include for each suggestionString(error)

...