App integration

The App Integration API provides parameters that can be used to create an URL that returns a complete HTML page containing the embedded app. This URL can be embedded in a web page, for example by including it in an iframe.

It allows you to pass parameters to an app and to open an app with one or several selections applied.

API reference: App Integration API

App integration examples

These examples make use of the App Integration API.

Integrating app

This example integrates the Qlik Sense demo app "Sales Discovery" (appid=4d541aea-a8b1-4cef-a4c2-6bda620321a9).

Example: iframe integration

<iframe src="https://<servername>/sense/app/4d541aea-a8b1-4cef-a4c2-6bda620321a9" />

Integrating sheet

This example integrates the Qlik Sense demo app "Sales Discovery" with sheet "Performance Dashboard" (sheetid=XuWLHFK).

Example: iframe integration

<iframe src="https://<servername>/sense/app/4d541aea-a8b1-4cef-a4c2-6bda620321a9/sheet/XuWLHFK/state/analysis" />

Integrating app with bookmark

This example integrates the Qlik Sense demo app "Sales Discovery" with bookmark "Sales Rep Name" (bookmarkid=UCVp).

Example: iframe integration

<iframe src="https://<servername>/sense/app/4d541aea-a8b1-4cef-a4c2-6bda620321a9/sheet/XuWLHFK/state/analysis/bookmark/UCVp" />

Integrating app with single selection

This example integrates the Qlik Sense demo app "Sales Discovery" selecting the Region Name "International" on the "Transactions" sheet (sheetid=zBAFH).

Example: iframe integration

<iframe src="https://<servername>/sense/app/4d541aea-a8b1-4cef-a4c2-6bda620321a9/sheet/zBAFH/state/analysis/select/Region Name/International" />

Integrating app with numeric value selections

For selections containing numeric values and search terms, the text representation should be added within square brackets, as in [value1].

This example integrates the Qlik Sense demo app "Sales Discovery" selecting the Month "Feb" which has a numeric value "2" on the "Transactions" sheet (sheetid=zBAFH).

Example: iframe integration text representation

<iframe src="https://<servername>/sense/app/4d541aea-a8b1-4cef-a4c2-6bda620321a9/sheet/zBAFH/state/analysis/select/Month/[Feb]/"/>

You can also define the numeric value instead of the text representation value, and the result will be the same.

Example: iframe integration numeric value

<iframe src="https://<servername>/sense/app/4d541aea-a8b1-4cef-a4c2-6bda620321a9/sheet/zBAFH/state/analysis/options/clearselections/select/Month/2" />

Clearing previous selections in app

You may want to clear all selections in the app before applying your own selections. To do so, add option parameter clearselections.

Example: iframe integration

<iframe src="https://<servername>/sense/app/4d541aea-a8b1-4cef-a4c2-6bda620321a9/sheet/zBAFH/state/analysis/options/clearselections/select/Region Name/International" />

Integrating app with multiple selections

This example integrates the Qlik Sense demo app "Sales Discovery" with the following selections made on the "Top Customers" sheet (sheetid=JTxTF).

Year: 2014
Region Name: Canada and International

The option parameter clearselections is also included to clear all previous selections in the app before applying our selections.

Example: iframe integration

<iframe src="https://<servername>/sense/app/4d541aea-a8b1-4cef-a4c2-6bda620321a9/sheet/XuWLHFK/state/analysis/options/clearselections/select/Year/2014/select/Region Name/International;Canada" />

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!

Leave your feedback here