Skip to main content Skip to complementary content

POST /apps/{appId}/insight-analyses/actions/recommend

Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.

Path parameters

Name Description Type
appId

Qlik Sense app identifier

String (uid)
accept-language

language specified as an ISO-639-1 code. Defaults to 'en' (English).

String

Request Body

Name Type
Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis. In below examples, consider sales as a master item and product as field, so to get recommendations using sales and product, you can utilize below three approaches, also you can set language parameter in headers as part of accept-language. Examples: ``` { 'text': 'show me sales by product' } ``` ``` { 'fields': [ { 'name': 'product' } ], 'libItems': [ { libId: 'NwQfJ' } ] } ``` ``` { 'fields': [ { 'name': 'product' } ], 'libItems': [ { 'libId': 'NwQfJ' } ], 'targetAnalysis': { 'id': 'rank-rank' } } ``` AnalysisRecommendRequest Required

Responses

Name Description Type
200

The request is successfully processed and recommendations are returned.

AnalysisRecommendationResponse
400

Bad request. The payload is not formed correctly.

Errors
401

User is not authorized

Errors
404

Not found

Errors
409

Invalid Business Logic

Errors
422

Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.

Errors
500

Internal server error

Errors

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 – let us know how we can improve!