Skip to main content Skip to complementary content

Single Integration API

Information noteIf you are using Qlik Sense Business or Qlik Sense Enterprise SaaS, see the API documentation at the Qlik (Developer Portal).
Information noteSTABLE.

This API is reliable and breaking changes are unlikely.


http[s]://<machinename | servername>/{virtual proxy}/single/?appid={appid}&obj={obj}&opt={options}&bookmark={bookmark}&select={selection}&theme={themeid}

Version history

Version state Details
Introduced 1.0
Updated 1.1, 3.0, 3.1, Sense February 2018
Information noteA new implementation of the Base URL was introduced in version 3.1. The legacy implementation of the URL will continue to work but use this new implementation for new integration.


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.

Tip noteUse the Single configurator to quickly get started using the Single Integration API, see Dev Hub: Single configurator.

Base URL

The Base URL is constant and defines the location of the machine.

Syntax: Base URL

http[s]://<machinename | servername>/{virtual proxy}/single/?

Parameter descriptions
Parameter Description
machinename | servername

Specifies the path to the local machine or the server on which the app is located.

  • https://<servername>/
  • http://localhost:4848/ for Qlik Sense Desktop environment.
virtual proxy

This parameter is optional depending on server configuration for the server.

Specifies the virtual proxy to use.

Retrieving the virtual proxy prefix programmatically

To get the virtual proxy prefix programmatically, you can use the following code in a browser console:

var prefix = window.location.pathname.substr( 0, window.location.pathname.toLowerCase().lastIndexOf( "/single" ) + 1 );

Legacy implementation of the base URL

Before version 3.1, the base URL had a slightly different syntax.

Syntax: Base URL

http[s]://<machinename | servername>/{virtual proxy}/single?

Additional parameters

The following parameters can be used to display a single visualization, a single sheet, or a single snapshot.

Additional parameters
Parameter Description

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

Example: appid example


Example: appid example in Qlik Sense Desktop



Defining the id of a Qlik Sense visualization.




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

Information noteSheets are not responsive when embedded with the Single Integration API. If responsiveness is wanted, embed individual visualizations instead.
Information noteThe sheet title is not included when embedding sheets.




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




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.


Override default language settings by defining the language for the specific object. Supported languages are:

  • Default language: This option does not add any language settings to the URL. The default language will be used.
  • German:

    short: de

    long: de-DE

  • English:

    short: en

    long: en-US

  • Spanish:

    short: es

    long: es-ES

  • French:

    short: fr

    long: fr-FR

  • Italian:

    short: it

    long: it-IT

  • Japanese:

    short: ja

    long: ja-JP

  • Korean: (introduced in Qlik Sense version 3.0)

    short: ko

    long: ko-KR

  • Dutch:

    short: nl

    long: nl-NL

  • Polish: (introduced in Qlik Sense version 3.0)

    short: pl

    long: pl-PL

  • Brazilian Portuguese:

    short: pt

    long: pt-BR

  • Russian:

    short: ru

    long: ru-RU

  • Swedish:

    short: sv

    long: sv-SE

  • Turkish: (introduced in Qlik Sense version 3.0)

    short: tr

    long: tr-TR

  • Simplified Chinese:

    short: Do not use!

    long: zh-CN

  • Traditional Chinese: (introduced in Qlik Sense version 3.0)

    short: Do not use!

    long: zh-TW





Defining options. Supported options are:

  • ctxmenu: enables the context menu.
  • currsel: displays the Selection bar.
  • debug: starts a JavaScript debugger.

    The debug option can only be defined in the URL.

  • noAnimate: turns off animations.

  • noselections: turns off selections.
  • noInteraction: turns off interaction.

If you want to define multiple options you separate them with a comma sign.




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

Introduced in Qlik Sense version 1.1.

This is the id of the bookmark to apply.

Example: Bookmark applied



Mandatory: Field name and values to select.

Optional: The name of the state to make selections in.

Introduced in Qlik Sense version 1.1.

The field name and the values define the selections to make. It is possible to define multiple select parameters.

Example: Selections in two fields


The example above selects the months of January, February, March and April and High priority.

Information noteYou have to define the number for numeric fields (Month in the example above), text will not work.

Example: Clear all selections in all states


Example: Clear all selections in the default state


Example: Clear all selections in one state

&select=My state::clearall

Example: Clear all selections in multiple states

&select=My first state::clearall&select=My second state::clearall

Example: Make a new selection in the default state

&select=Year,2011 or &select=$::Year,2011

Example: Make a new selection in multiple fields


Example: Make a new selection for multiple values


Example: Make a new selection in one state

&select=My state::Year,2011

Example: Make a new selection in multiple states

&select=My first state::Year,2011&select=My second state::Year,2012


Defining the id of a theme.

Introduced in Qlik Sense February 2018.

Example: Theme applied


Execution order

The execution order of rendering a HTML page containing the object and its set options is as follows:

  1. Clear existing selections (if applicable).
  2. Apply a bookmark (if applicable).
  3. Make selections in fields (if applicable).

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!