API reference for Windows

The following API reference is for Qlik Sense Enterprise on Windows only.

If you are interested in cloud editions APIs, we recommend you see the API reference for cloud editions of Qlik Sense Enterprise.

Building mashups and custom visualization objects

Use these resources to build and bring capabilities into visualization extensions, widgets, custom components, and mashups.

API name API type Visualization extensions Widgets Custom components Mashups
Engine JSON API JSON RPC Yes No No Yes
Extension API JavaScript library Yes No No No
Backend API JavaScript library Yes No No No
Root API

JavaScript library (Capability API)

Yes No Yes Yes
App API

JavaScript library (Capability API)

Yes Yes Yes Yes
Bookmark API

JavaScript library (Capability API)

Yes No Yes Yes
Field API

JavaScript library (Capability API)

Yes No Yes Yes
Global API

JavaScript library (Capability API)

Yes No Yes Yes
Navigation API

JavaScript library (Capability API)

Yes Yes Yes No
Selection API

JavaScript library (Capability API)

Yes No Yes Yes
Table API

JavaScript library (Capability API)

Yes Yes Yes Yes
Theme API

JavaScript library (Capability API)

No No No Yes
Variable API

JavaScript library (Capability API)

Yes No Yes Yes
Visualization API

JavaScript library (Capability API)

No No No Yes
Custom Component API Web component No No Yes No
App Integration API URL integration No No No Yes
Single Integration API

URL integration

No No No Yes
qlik-visual Web component No Yes No Yes
enigma.js JavaScript library (Open Source) Yes No Yes Yes
enigma-go Go library (Open Source) Yes No Yes Yes
leonardo-ui UI library (Open Source) Yes Yes Yes Yes
picasso.js JavaScript library (Open Source) Yes No Yes Yes

 

Building connectors

Use the QVX SDK to build customized connectors, used to retrieve data from data sources not supported by a generic Qlik Sense installation.

QVX SDK

Building Windows applications

Use the .NET SDK to integrate Qlik Sense in your own Windows (.NET) applications.

.NET SDK

Managing and automating administrative jobs

Use the REST APIs to manage data, configuration information and authentication.

Retrieving information about the product

Use the REST API to retrieve product information including details about the system, components, external URLs, and third-party software.

Creating on-demand apps

Use the REST API to create on-demand apps by accessing the ODAG Service API.

Importing users and groups

Use the .NET API to import users and groups in Qlik Sense.

API Insights

See API Insights for a history of API changes.

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?