Get Content Suggestions
GET {{baseUrl}}/api/-/suggestions?terms=<string>&limit=<integer>&recentsLuids=<string>&filter=<string>
Returns a specified number of suggestions for auto-completion of user input as they type. You can specify content types of suggestions and prioritize recently viewed content.
Version: Available in API 3.19 ( Tableau Cloud March 2023 / Server 2023.1) and later. Versioning Overview
Permissions: Suggestions will be limited to those objects that the user has permissions to access. Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud | Server-Windows | Server-Linux
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
terms | string | (Required) The term that is matched to find suggestions. | |
limit | string | The number of suggestions to return. The default is 10. | |
recentsLuids | string | A comma separated list of luids that will be prioritized in scoring of content items matched to suggest. | |
filter | string | A filter to restrict suggestions to specified content types. The supported operators are: in and eq. For instance, the parameter: filter:in:workbooks,datasources would limit suggestions returned to only those for workbooks and data sources. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"terms":"\u003cstring\u003e","filter":"\u003cstring\u003e","sort":"\u003cstring\u003e","hits":{"next":"\u003cstring\u003e","prev":"\u003cstring\u003e","pageIndex":"\u003clong\u003e","startIndex":"\u003clong\u003e","total":"\u003clong\u003e","limit":"\u003cinteger\u003e","items":[{"uri":"\u003cstring\u003e","content":{"quis0":{},"adipisicing99":{}}},{"uri":"\u003cstring\u003e","content":{"aliquip_da":{},"do_2_":{}}}]}}