This API is reliable and breaking changes are unlikely.
Syntax
http[s]://<machinename | servername>/{virtual proxy}/single/?appid={appid}&obj={obj}&opt={options}&bookmark={bookmark}&select={selection}&theme={themeid}
Version history
| Introduced | 1.0 |
| Updated | 1.1, 3.0, 3.1, Sense February 2018 |
Overview
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.
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 | Description |
|---|---|
| machinename | servername |
Specifies the path to the local machine or the server on which the app is located.
|
| 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.
| Parameter | Description |
|---|---|
| appid |
Defining the id of a Qlik Sense app. If no appid is available, the file name will be listed. Example: appid example appid=133dab5d-8f56-4d40-b3e0-a6b401391bde Example: appid example in Qlik Sense Desktop appid=<FolderPath>%5CHelpdesk%20Management.qvf |
| obj |
Defining the id of a Qlik Sense visualization. Example: &obj=hRZaKk |
| sheet |
Defining the id of a sheet in a Qlik Sense app. Example: &sheet=1ff88551-9c4d-41e0-b790-37f4c11d3df8 |
| snapshot |
Defining the id of a snapshot in a Qlik Sense app. Introduced in Qlik Sense version 1.1. Example: &snapshot=EwrnQf |
| identity |
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 |
Override default language settings by defining the language for the specific object. Supported languages are:
Examples: &lang=es &lang=es-ES |
| opt |
Defining options. Supported options are:
If you want to define multiple options you separate them with a comma sign. Example: &opt=currsel |
| callback |
Registering callbacks. Introduced in Qlik Sense version 1.1. This is the package name for callback functions. Use 'test' for testing and use 'external' for integration based on Internet Explorer web component. Information noteThe callback parameter is not supported for sheets.
See: Callback reference |
| bookmark |
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 &bookmark=PzsxuKb |
| select |
Field name and values to select. 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 &select=Month,1,2,3,4&select=Priority,High 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 &select=clearall Example: Clear all selections and then make a new selection &select=clearall&select=Year,2011 |
| theme |
Defining the id of a theme. Introduced in Qlik Sense February 2018. Example: Theme applied &theme=breeze |
Callback reference
Use callbacks when you use the single feature as an embedded component in, for example, a .NET environment. Callbacks are called if a callback package is defined as a parameter in the URL.
The following callbacks are defined
- window[callback package]onError: called when an error occurs. Default is to use a JavaScript alert for errors.
- window[callback package]onValid: called when an object receives valid data from Qlik engine.
- window[callback package]onRendered: called when an object is rendered.
Execution order
The execution order of rendering a HTML page containing the object and its set options is as follows:
- Clear existing selections (if applicable).
- Apply a bookmark (if applicable).
- 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!