Javascript Search Library - 1.4: Links

Javascript Search Library - 1.4: Links

Overview

Uses the links endpoint to retrieve link configured in the EmpathyBroker dashboard.

Step-by-step guide

You can search using the search function.

links (term, maxitems, scope, options, callback)


Parameters

Parameter

Description

Data Type

Mandatory

Parameter

Description

Data Type

Mandatory

terms

The query typed by the user

String

Yes

maxitems

Max number of links to be retrieved

Integer

No

scope

This parameter is used for separate analytic data between two or more different scenarios

String

No

options

Object that may contain information about filters and other required data.

Object

No

callback

Function that will be executed after sending data

Function

No

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 samples

var options = { lang:'en' } empathySearch.links('term', 10, 'testscope', options, function(data){ //the data object will contain link results alert('test'); });


Related articles

Filter by label

There are no items with the selected labels at this time.