Versions Compared

Key

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

...

ParameterDescriptionData TypeMandatory
termsThe query typed by the userStringYes
maxitemsMax number of links to be retrievedIntegerNo
scopeThis parameter is used for separate analytic data between two or more different scenariosStringNo
optionsObject that may contain information about filters and other required data for example: scope, user and session.ObjectNo
callbackFunction that will be executed after sending dataFunctionNo

Notes:

  • Additional parameters should be included into the options object. The list of parameters that can be included into the options parameter can be checked visiting the Links section of SEARCH REST API

...

Code Block
languagejs
var options = {
    lang:'en',
    scope:'desktop',
    user:'8212e2d6-fcbd-4879-9878-b06299ee785e',
    session:
'3087bd26-2e69-4e84-84c3-e130e06e4888'
}
empathySearch.links('term', 10, 'testscope', options, function(data){
    //the data object will contain link results
    alert('test');
});

...