AppIntegrationAPI
The App Integration API provides parameters that can be used to create a 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.
URL
interfaceReturns
string | HTML page rendering a Qlik Sense visualization or a sheet. |
Properties
appid string | App ID of the referenced app. |
sheetid string | Sheet ID of the referenced sheet. |
bookmark optional string | You add a bookmark definition by stating the bookmark ID in addition to the Base URL. |
options optional | Add option definitions in addition to the Base URL. |
select optional string | Selection definitions can be added to the Base URL. Selections can be made in a single field or in multiple fields. Multiple values are separated by a semicolon. |
theme optional string | Add a theme definition by stating the theme ID in addition to the Base URL. Introduced in Qlik Sense 4.0 |
language optional string | Override default language settings by defining the language. |
**Add a bookmark definition by stating the bookmark ID in addition to the Base URL**
```
http[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/bookmark/{bookmarkid}
```
**Add option definitions in addition to the Base URL**
```
http[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/options/{option}
```
**Selection in single field that has text representation of numeric values:**
```
http[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/select/{field}/{[value1];[value2]}
```
**Selections in multiple fields:**
```
http[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/select/{field}/{value1;value2}/select/{field2}/{value1;value2}
```
**Applying a theme:**
```
http[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/theme/{themeid}
```