API reference for Windows
The following API reference is for Qlik Sense Enterprise on Windows only.
Check out the API reference documentation in the site Qlik Developer instead.
Building mashups and custom visualization objects
Use these resources to build and bring capabilities into visualization extensions, and mashups.
If you're planning to use capability APIs to embed Qlik into your web apps or mashups, consider using Qlik's primary embedding framework, qlik-embed.
For building custom visualizations or extensions, consider using the nebula.js collection of JavaScript libraries, visualizations, and CLIs that help developers build and integrate visualizations on top of Qlik's Associative Engine.
| 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 |
| 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.
Building Windows applications
Use the .NET SDK to integrate Qlik Sense in your own Windows (.NET) applications.
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.
Checking the health of Qlik services
The following API endpoints are available for service health checks. Use the HTTP GET method to call the API endpoint. If the service is running correctly, you should receive a 200 status code.
| Service | API endpoint |
|---|---|
| Qlik Repository | https://{QSE_domain}/qrs/about |
| Qlik Proxy | https://{QSE_domain}:4243/qps/alive |
| Qlik Engine |
https://{QSE_domain}:4747/healthcheck (or https://{QSE_domain}/engine/healthcheck) |
| Qlik Scheduler |
https://{QSE_domain}:5050/qss/alive (Use port 5151 for slave scheduler) |
| Qlik Printing |
https://{QSE_domain/printing/alive |