Overview of Qlik APIs

Authenticate

Associated APIs

.well known

Authenticate
REST

No description

API keys

Authenticate
REST

API keys can be used by developers to gain programmatic access to the Qlik platform, acting as their own user.

Login

Authenticate
REST

This API is used to interact with Edge Auth resources in Qlik elastic environments.

OAuth

Authenticate
REST

This API is used to interact with Edge Auth resources in Qlik elastic environments.

OAuth tokens

Authenticate
REST

This API is used to interact with Edge Auth resources in Qlik elastic environments.

Web integrations

Authenticate
REST

A web integration is a resource representing a list of whitelisted origins that can make requests to a specified tenant. It is the implementation of the CORS mechanism within Qlik Sense SaaS.

Build

Associated APIs

Apps

Build
REST

Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.

AutoML Dataset Predictions

Build
REST

No description

AutoML Real time Predictions

Build
REST

No description

Automations

Build
REST

Qlik Application Automation is a visual, no-code approach to connecting applications.

Conditions

Build
REST

Conditions is the resource representing a condition query based on data in a Qlik app.

Data assets

Build
REST

Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.

Data files

Build
REST

API for uploading and managing user data files

Data sets

Build
REST

Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.

Data stores

Build
REST

Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.

Evaluations

Build
REST

The `app-evaluator` service is responsible for running in-cluster performance and scalability tests/evaluations of apps

Reports

Build
REST

Request a report generation.

Embed

Associated APIs

App Integration

v1.1.1
Embed
javascript

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.

Capabilities

v1.8.0
Embed
javascript

The Capability APIs are a collection of JavaScript APIs that allows you to easily embed Qlik Sense content into a web page, and interact with data. With just a few lines of code, it is possible to create a visualization that leverages the Qlik Sense visualization library.

Nebula Bar chart

v1.34.6
Embed
javascript

Bar chart generic object definition

Nebula Box plot chart

v0.26.7
Embed
javascript

Boxplot generic object definition

Nebula Bullet chart

v1.24.6
Embed
javascript

Bullet chart generic object definition

Nebula Button

v1.28.1
Embed
javascript

Action button generic object definition

Nebula Combo chart

v1.26.9
Embed
javascript

Combo chart generic object definition

Nebula Distribution plot chart

v0.25.13
Embed
javascript

Distributionplot generic object definition

Nebula Filter Pane

v0.17.1
Embed
javascript

Filter pane generic object definition

Nebula Funnel chart

v1.8.0
Embed
javascript

Funnel chart generic object definition

Nebula Grid chart

v1.13.3
Embed
javascript

Grid chart generic object definition

Nebula Histogram chart

v0.25.10
Embed
javascript

Histogram generic object definition

Nebula KPI

v0.13.4
Embed
javascript

KPI generic object definition

Nebula Line chart

v1.30.8
Embed
javascript

Line chart generic object definition

Nebula Listbox properties

v4.8.0
Embed
javascript

nebula listbox properties definition

Nebula Mekko chart

v1.3.0
Embed
javascript

Mekko chart generic object definition

Nebula Network chart

v1.0.4
Embed
javascript

Network chart generic object definition

Nebula Org chart

v1.0.3
Embed
javascript

Org chart generic object definition

Nebula Pie chart

v1.26.6
Embed
javascript

Pie chart generic object definition

Nebula Pivot table

v2.5.2
Embed
javascript

Pivot Table generic object definition

Nebula Sankey chart

v1.9.1
Embed
javascript

Sankey chart generic object definition

Nebula Scatter plot

v3.53.0
Embed
javascript

Scatter plot generic object definition

Nebula Scatter plot plugins

v3.53.0
Embed
javascript

Scatter plot plugins API definitions

Nebula Table

v2.7.0
Embed
javascript

Table generic object definition

Nebula Treemap

v1.6.5
Embed
javascript

Treemap generic object definition

Nebula Waterfall chart

v0.25.11
Embed
javascript

Waterfall chart generic object definition

Nebula Word Cloud

v1.0.6
Embed
javascript

Word cloud generic object definition

Sense Client Objects

v1.4.0
Embed
javascript

Sense Client Objects consists of a collection of properties for defining different types of objects compatible with Qlik Sense Client

Single Integrations

v1.2.1
Embed
javascript

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.

Enigma.js

v2.7.3
Embed
javascript

JavaScript library for consuming Qlik backend services

Nebula.js: stardust

v4.8.0
Embed
javascript

Product and framework agnostic integration API for Qlik's Associative Engine

CSP origins

Embed
REST

CSP origins allows you to configure domains, or origins, that Qlik Sense client visualizations/extensions are allowed to communicate with.

CSRF token

Embed
REST

This API is used to interact with the CSRF token resource in Edge Auth in Qlik elastic environments.

Natural Language

Embed
REST

Ask natural languages questions and context aware partial questions against applications enabled for conversational analytics or a specific app to receive Insight Advisor generated responses and suggestions

Extend

Associated APIs

Extensions

v1.1.1
Extend
javascript

The Extension API consists of methods and properties used to create custom visualization extensions.

Sense Client Objects

v1.4.0
Extend
javascript

Sense Client Objects consists of a collection of properties for defining different types of objects compatible with Qlik Sense Client

Enigma.js

v2.7.3
Extend
javascript

JavaScript library for consuming Qlik backend services

Nebula.js: stardust

v4.8.0
Extend
javascript

Product and framework agnostic integration API for Qlik's Associative Engine

Picasso.js

v2.2.5
Extend
javascript

A charting library streamlined for building visualizations for the Qlik Sense Analytics platform.

Extensions

Extend
REST

Extensions is a powerful capability in Qlik Sense which allows third-party visualizations and other presentation objects to be used in the Qlik Sense client.

Themes

Extend
REST

Themes enable you to customize/style the Qlik Sense client experience.

Manage

Associated APIs

Apps

Manage
event

Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.

Users

Manage
event

Users is the resource that represents a user in the platform.

QIX

Manage
json-rpc

The JSON-RPC API over websocket that enables you to interact with the Qlik Associative Engine.

Apps

Manage
REST

Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.

Audits

Manage
REST

The audit resource allows you to gain insight of what goes on in your tenant.

Automations

Manage
REST

Qlik Application Automation is a visual, no-code approach to connecting applications.

Brands

Manage
REST

No description

Collections

Manage
REST

Collections is a way to catalog various content a user has access to, and group that content based on various properties.

Consumption

Manage
REST

No description

Data alerts

Manage
REST

Supports chart sharing, chart monitoring and alerting features. The legacy sharing APIs refer to chart sharing and chart monitoring, which is a feature that allows the user to send an e-mail with an embedded chart either manually (chart sharing) or in a recurring manner (chart monitoring). It also stores the history related to these actions. The alerting/ data-alerts APIs support the alerting feature, where a user is able to create alerts that trigger notifications in case a condition in the dataset of an app is fulfilled.

Data connections

Manage
REST

data-connections is the resource representing a connection

Data credentials

Manage
REST

data-credentials is the resource representing a credential

Data files

Manage
REST

API for uploading and managing user data files

Dcaas

Manage
REST

No description

Encryption

Manage
REST

No description

Glossaries

Manage
REST

A glossary is a collection of common and agreed upon (business) terms, typically focused on defining the meaning of data and described in terms that everyone understands.

Groups

Manage
REST

Groups is the resource representing a group in the system.

Identity providers

Manage
REST

A service for managing identity providers.

Items

Manage
REST

Items is a discovery API for core resources in the Qlik platform. This API is used to list apps and other resources a user has access to.

Licenses

Manage
REST

Licenses is the resource representing tenant and user entitlements.

Lineage graphs

Manage
REST

Lineage-graphs represents the lineage information for a specific Qlik item.

Notes

Manage
REST

CRUD for notes and note syncing APIs for real time collaborative editing

Notification digests

Manage
REST

Supports chart sharing, chart monitoring and alerting features. The legacy sharing APIs refer to chart sharing and chart monitoring, which is a feature that allows the user to send an e-mail with an embedded chart either manually (chart sharing) or in a recurring manner (chart monitoring). It also stores the history related to these actions. The alerting/ data-alerts APIs support the alerting feature, where a user is able to create alerts that trigger notifications in case a condition in the dataset of an app is fulfilled.

Notifications

Manage
REST

notifications is the resource representing the various notifications that notification-prep can render

Quotas

Manage
REST

Quotas is the resource representing tenant quotas originating from the license.

Reload tasks

Manage
REST

reload-tasks allows for publishing a reload schedule job request to the job queue, and for handling CRUD operations of scheduled reload tasks.

Reloads

Manage
REST

Reloads allows for triggering reloads of apps to refresh its data. Traditionally this has only been possible through the JSON-RPC websocket API, but can now also be done by using this REST API.

Roles

Manage
REST

The resource representing a role in the system.

Spaces

Manage
REST

Spaces is a central concept in the Qlik platform and is used to control access to various other resources in the system.

Temp contents

Manage
REST

No description

Tenants

Manage
REST

Tenants is the resource representing a tenant.

Transports

Manage
REST

No description

Users

Manage
REST

The resource representing a user in the system.

Web notifications

Manage
REST

Web notifications is the resource representing a user's notification

Webhooks

Manage
REST

Webhooks are a way for Qlik Cloud to provide other applications with real-time information.

Was this page helpful?