REST API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Search Suggested Queries
Salesforce Knowledge must be enabled in your organization.
Queries are suggested if they exactly match the query string text. The text string must be a prefix within the query; it’s not considered a match if it appears within a word. For example, the text string app would return suggested queries apple banana and banana apples but not pineapple.
If the number of suggestions returned exceeds the limit specified in the request, the end of the response contains a field called hasMoreResults. Its value is true if the suggestions returned are only a subset of the suggestions available, and false otherwise.
If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI.
Syntax
URI: /services/data/vXX.X/search/suggestSearchQueries?q=searchString&language=languageOfQuery
Formats: JSON, XML
HTTP methods: GET
Authentication: Authorization: Bearer token
Request body: None required
| Parameter | Description |
|---|---|
| channel | Optional. Specifies the Salesforce Knowledge channel where the article can be viewed. Valid values are AllChannels (visible in all channels the user has access to), App (visible in the internal Salesforce Knowledge application), Pkb (visible in the public knowledge base), Csp (visible in the Customer Portal), or Prm (visible in the Partner Portal). See the channel default values and specified-value requirements after this table. |
| language | Required. The language of the user’s query. |
| limit | Optional. Specifies the maximum number of suggested searches to return. If there are more suggested queries than the limit specified, the response body’s hasMoreResults property is true. |
| q | Required. The user’s search query string, properly URL-encoded. Suggestions are returned only if the user’s query string meets the minimum length requirements: one character for queries in Chinese, Japanese, and Korean, and three characters for all other languages. Query strings exceeding the maximum length of 250 characters return an error. |
If channel isn’t specified, the default value is determined by the type of user.
- Pkb for a guest user
- Csp for a Customer Portal user
- Prm for a Partner Portal user
- App for any other type of user
If channel is specified, the specified value may not be the actual value requested, because of certain requirements.
- For guest, Customer Portal, and Partner Portal users, the specified value must match the default value for each user type. If the values don’t match or AllChannels is specified, then App replaces the specified value.
- For all users other than guest, Customer Portal, and Partner Portal users, if Pkb, Csp, Prm, or App are specified, then the specified value is used. If AllChannels is specified, then App replaces the specified value.
Valid channel values (also referenced by Search Suggested Article Title Matches):
- AllChannels–Visible in all channels the user has access to
- App–Visible in the internal Salesforce Knowledge application
- Pkb–Visible in the public knowledge base
- Csp–Visible in the Customer Portal
- Prm–Visible in the Partner Portal
Example
Example Request
1curl https://MyDomainName.my.salesforce.com/services/data/v67.0/search/suggestSearchQueries?
2q=app&language=en_US -H "Authorization: Bearer token"Example Response Body
1{
2 "autoSuggestResults" : [ {
3 "0" : "apple",
4 "1" : "apple banana",
5 } ],
6 "hasMoreResults" : false
7}