searchSuggest method | Qlik Sense for developers Help
Skip to main content Skip to complementary content

searchSuggest method

Last updated: 9/3/2026
Information noteSTABLE.

This API is reliable and breaking changes are unlikely.

qlik.app.searchSuggest(qTerms, qOptions, callback)

Returns suggestions of words from the values entered in the search. Acts as a helper for the searchResults method.

Version history

Version history
Version state Details
Introduced 1.1

Parameters

qTerms

Type: Array

Terms to search for.

qOptions

Type: Object

Optional.

Search options.

Properties:

qOptions object properties
Name Type Description
qSearchFields Array List of search fields.

callback

Type: Function

Optional.

Callback method. Registers a callback that is executed every time data is returned.

Returns

A promise of a Qlik associative engine reply.

Tip noteFor more information regarding a promise, see The Promise API.

Example

app.searchSuggest(["se"], {}, function(reply) {
	var str = "";
		reply.qResult.qSuggestions.forEach(function(sugg){
			str += sugg.qValue + ' ';
		});
		alert(str);
	});

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!