KustomerCore.searchArticles()

Searches for articles in your knowledge base

πŸ‘

First, initialize chat

You must initialize with KustomerCore.init() before you can execute any additional Core SDK methods

Examples

// Searches for articles based on a search term
KustomerCore.searchArticles({
  term: 'returns and refunds',
  lang: 'en_us',
  knowledgeBaseId: 'SOME_ID'
}, function (callbackResponse, error) {
  console.log('Searched for articles!');
});

Syntax

KustomerCore.searchArticles(options, function(callbackResponse, error))
ParameterTypeDescription
optionsObjectRequired

An object containing details about the articles you want to search. A breakdown of the options object is listed below.
function(callbackResponse, error)FunctionOptional

A callback that is run after the method completes.

callbackResponse is an object returned to the callback function. See the callbackResponse section below to see the properties of the object.

error is either undefined or a native JavaScript Error object.

options

PropertyTypeDescription
knowledgeBaseIdStringRequired

The unique ID of the knowledge base.
langStringRequired

The language code of the categories to fetch.
termStringRequired

The search term you want to search for.

callbackResponse

PropertyTypeDescription
articlesArrayRequired

A list of article objects. See articles below for an example.

articles

The following is a breakdown of what an item in the articles array looks like.

PropertyTypeDescription
articleIdStringRequired

The unique ID of the article.
htmlBodyStringRequired

The article's html body.
titleStringRequired

The article's title.
descriptionStringRequired

The article's description.
updatedAtStringRequired

The article's last updated at timestamp.
langStringRequired

The article's language code.
slugStringRequired

The article's slug for its url.
versionStringRequired

The version of the article.
hashStringRequired

The article's hash code.
kbUrlStringOptional

The article's knowledge base URL.
knowledgeBaseIdStringOptional

The article's knowledge base ID.