Overview of Qlik APIs
Authenticate
Associated APIs
API keys
API keys can be used by developers to gain programmatic access to the Qlik platform, acting as their own user.
Login
This API is used to interact with Edge Auth resources in Qlik elastic environments.
OAuth
This API is used to interact with Edge Auth resources in Qlik elastic environments.
OAuth tokens
This API is used to interact with Edge Auth resources in Qlik elastic environments.
Web integrations
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
Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.
Automations
Qlik Application Automation is a visual, no-code approach to connecting applications.
Conditions
Conditions is the resource representing a condition query based on data in a Qlik app.
Data assets
Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.
Data sets
Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.
Data stores
Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.
Evaluations
The `app-evaluator` service is responsible for running in-cluster performance and scalability tests/evaluations of apps
Embed
Associated APIs
App Integration
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
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.
Sense Client Objects
Sense Client Objects consists of a collection of properties for defining different types of objects compatible with Qlik Sense Client
Single Integrations
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.
Nebula.js: stardust
Product and framework agnostic integration API for Qlik's Associative Engine
CSP origins
CSP origins allows you to configure domains, or origins, that Qlik Sense client visualizations/extensions are allowed to communicate with.
CSRF token
This API is used to interact with the CSRF token resource in Edge Auth in Qlik elastic environments.
Natural Language
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
The Extension API consists of methods and properties used to create custom visualization extensions.
Sense Client Objects
Sense Client Objects consists of a collection of properties for defining different types of objects compatible with Qlik Sense Client
Nebula.js: stardust
Product and framework agnostic integration API for Qlik's Associative Engine
Picasso.js
A charting library streamlined for building visualizations for the Qlik Sense Analytics platform.
Extensions
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.
Manage
Associated APIs
Apps
Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.
QIX
The JSON-RPC API over websocket that enables you to interact with the Qlik Associative Engine.
Apps
Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.
Audits
The audit resource allows you to gain insight of what goes on in your tenant.
Automations
Qlik Application Automation is a visual, no-code approach to connecting applications.
Collections
Collections is a way to catalog various content a user has access to, and group that content based on various properties.
Data alerts
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.
Glossaries
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.
Items
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.
Lineage graphs
Lineage-graphs represents the lineage information for a specific Qlik item.
Notification digests
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
notifications is the resource representing the various notifications that notification-prep can render
Quotas
Quotas is the resource representing tenant quotas originating from the license.
Reload tasks
reload-tasks allows for publishing a reload schedule job request to the job queue, and for handling CRUD operations of scheduled reload tasks.
Reloads
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.
Spaces
Spaces is a central concept in the Qlik platform and is used to control access to various other resources in the system.
Web notifications
Web notifications is the resource representing a user's notification
Webhooks
Webhooks are a way for Qlik Cloud to provide other applications with real-time information.
