Typeahead Suggestion

Overview

This API returns typeahead suggestions for a given search query string based on topics and article's content.

Input search query string length should be greater than 2 characters for the API to respond.

SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer

Request

path Parameters

portalID

required

number

Example: 202200000001001

query Parameters

q required	string The search query string. The string must be escaped as required by the URL syntax rules. Example: q=credit
maxCount	number Maximum number of suggestions to be presented for auto-complete Example: maxCount=9
excludeType	string Type of resource to be fetched. Enum: "article" "topic"
filter[tags]	string A comma separated list of Tag / Tag Group IDs. Tag IDs and Tag Group IDs can be mixed together. Example: filter[tags]=202200000001177,202200000001185

header Parameters

Accept-Language required	string Default: en-US Language locale accepted by client (used for locale specific fields in resource representation and in error responses). Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
X-egain-tenant-id	string Unique identifier for tenant.
X-egain-activity-id	integer Numeric unique identifier of interaction from eGain.
X-interaction-id	string Unique identifier for interaction from other CRM applications.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/portals/{portalID}/search/typeahead

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"suggestion": [{"suggestion": "article",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [ ]
}
]
},
"entityId": 777700000002233,
"alternateId": "DEV1-2233",
"languageId": 1,
"suggestionType": "Article",
"articleTypeAttributes": {"typeName": "General"
}
},
{"suggestion": "New article",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [{"firstPos": 0,
"lastPos": 4
}
]
}
]
},
"suggestionMetadata": "'Virtual Assistant'",
"entityId": 777700000002125,
"alternateId": "DEV1-2125",
"languageId": 1,
"suggestionType": "Article",
"articleTypeAttributes": {"typeName": "General"
}
},
{"suggestion": "macro article",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [{"firstPos": 0,
"lastPos": 6
}
]
}
]
},
"suggestionMetadata": "'Personalized'",
"entityId": 777700000002240,
"alternateId": "DEV1-2240",
"languageId": 1,
"suggestionType": "Article",
"articleTypeAttributes": {"typeName": "General"
}
},
{"suggestion": "Downgrade Product article",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [{"firstPos": 0,
"lastPos": 18
}
]
}
]
},
"suggestionMetadata": "'Solution Articles'",
"entityId": 777700000002185,
"alternateId": "DEV1-2185",
"languageId": 1,
"suggestionType": "Article",
"articleTypeAttributes": {"typeName": "General"
}
},
{"suggestion": "article with filter",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [{"firstPos": 7,
"lastPos": 19
}
]
}
]
},
"suggestionMetadata": "'Personalized'",
"entityId": 777700000002237,
"alternateId": "DEV1-2237",
"languageId": 1,
"suggestionType": "Article",
"articleTypeAttributes": {"typeName": "General"
}
},
{"suggestion": "article with AISG",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [{"firstPos": 7,
"lastPos": 17
}
]
}
]
},
"suggestionMetadata": "'Personalized'",
"entityId": 777700000002238,
"alternateId": "DEV1-2238",
"languageId": 1,
"suggestionType": "Article",
"articleTypeAttributes": {"typeName": "General"
}
},
{"suggestion": "article using macro",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [{"firstPos": 7,
"lastPos": 19
}
]
}
]
},
"suggestionMetadata": "'Personalized'",
"entityId": 777700000002241,
"alternateId": "DEV1-2241",
"languageId": 1,
"suggestionType": "Article",
"articleTypeAttributes": {"typeName": "General"
}
},
{"suggestion": "Virtual Assistant&nbsp;&gt;&nbsp;Solution Articles",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [{"firstPos": 0,
"lastPos": 42
},
{"firstPos": 49,
"lastPos": 50
}
]
}
]
},
"entityId": 777700000001005,
"languageId": 1,
"suggestionType": "Topic"
},
{"suggestion": "Virtual Assistant&nbsp;&gt;&nbsp;Solution Articles",
"textMetadata": {"highlightMetadata": [{"attributeName": "suggestion",
"characterRange": [{"firstPos": 0,
"lastPos": 42
},
{"firstPos": 49,
"lastPos": 50
}
]
}
]
},
"entityId": 777700000001018,
"languageId": 1,
"suggestionType": "Topic"
}
]
}