---
source: https://qlik.dev/apis/javascript/single-integration/
last_updated: 2026-01-19T15:48:02Z
---

# Single Integrations

`Version: 1.2.1` | _stable_

The Single Integration API provides parameters that can be used to create a URL that returns a complete HTML page containing, for example, an embedded Qlik Sense visualization. This URL can be embedded in a web page by including it in an iFrame. Consider using the qlik-embed toolkit with the classic/chart or analytics/chart UI instead to mitigate for third-party cookie blocking issues in modern browsers.

## Table of Contents

### Definitions

- [URL](#url-interface)

## Definitions

### URL `interface`

#### Returns

`string` - HTML page rendering a Qlik Sense visualization or a sheet.

#### Properties

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `appid` | string | Yes | - | ID of a Qlik Sense app. If no `appid` is available, the file name will be listed. |
| `obj` | string | Yes | - | ID of a Qlik Sense visualization. |
| `sheet` | string | Yes | - | ID of a sheet in a Qlik Sense app. |
| `snapshot` | string | Yes | - | ID of a snapshot in a Qlik Sense app. Introduced in Qlik Sense 1.1. |
| `identity` | string | No | - | 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 do not affect a concurrent session in the Qlik Sense client. |
| `lang` | string | No | - | Override default language settings by defining the language for the specific object. |
| `opt` | object | No | - | Defining options. Supported options are: |
| `callback` | string | No | - | Registering callbacks. |
| `bookmark` | string | No | - | ID of a bookmark in a Qlik Sense app. |
| `select` | string | No | - | Field name and values to select. |
| `theme` | string | No | - | Add a theme definition by stating the theme ID in addition to the Base URL. Introduced in Qlik Sense 4.0. |

<details>
<summary>Properties of `opt`</summary>

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `currsel` | string | No | - | displays the Selection bar. |
| `currsel-dark` | string | No | - | displays the Selection bar dark mode. |
| `debug` | string | No | - | starts a JavaScript debugger. The debug option can only be defined in the URL. |
| `noanimate` | string | No | - | turns off animations. |
| `noselections` | string | No | - | turns off selections. |
| `nointeraction` | string | No | - | turns off interaction. |
| `ctxmenu` | string | No | - | enables the context menu. |

</details>

<details>
<summary>Examples</summary>

**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&
```

</details>

---