SingleIntegrationAPI

v1.2.0

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

URL

interface

Returns

string

HTML page rendering a Qlik Sense visualization or a sheet

Properties

appid
string

Defining the id of a Qlik Sense app. If no appid is available, the file name will be listed.

obj
string

Defining the id of a Qlik Sense visualization.

sheet
string

Defining the id of a sheet in a Qlik Sense app.

snapshot
string

Defining the id of a snapshot in a Qlik Sense app. Introduced in Qlik Sense version. Since Qlik Sense 1.1

identity
optional
string

Defining a session identity. If no identity is defined, the session and selection state will be shared with the client. If an identity is defined, a separate session is created and any selections made in the single feature does not affect a concurrent session in the Qlik Sense client.

lang
optional
string

Override default language settings by defining the language for the specific object.

opt
optional

Defining options. Supported options are:

callback
optional
string

Registering callbacks.

bookmark
optional
string

Defining the id of a bookmark in a Qlik Sense app.

select
optional
string

Field name and values to select.

theme
optional
string

Add a theme definition by stating the theme ID in addition to the Base URL. Introduced In Qlik Sense 4.0

**Defining multiple preselected values:**
```html
<iframe src='https://sense-demo.qlik.com/single/?appid=133dab5d-8f56-4d40-b3e0-a6b401391bde&obj=298bbd6d-f23d-4469-94a2-df243d680e0c&select=Priority,High,Medium&select=Year,2012' frameborder='0'>
```

**Defining preselected values and bookmarks:**
```
http[s]://<machinename | servername>/{virtual proxy}/single?appid=133dab5d-8f56-4d40-b3e0-a6b401391bde&
```