How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Apps API

Manage Qlik Sense applications including creating, updating, publishing, and deleting apps in Qlik Cloud.

Qlik Apps API is one of 82 APIs that Qlik Sense APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Application, Cloud, and REST. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 48 operations across 33 paths, organized into 4 resource areas, and defines 134 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

48 operations 33 paths 134 schemas 6 DELETE23 GET2 PATCH11 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://{tenant}.{region}.qlikcloud.com/api/v1/apps
Resource Areas
4

Paths & Operations 48

Across 33 paths, the API surfaces 48 operations — 6 DELETE, 23 GET, 2 PATCH, 11 POST, 6 PUT. They span 4 resource areas: Operations, insight-analyses, filters, evaluation. Each is listed below with its method, path, parameters, and response codes.

Operations 33
POST
/api/v1/apps
Creates a new app.
body → 200
GET
/api/v1/apps/{appId}
Retrieves information for a specific app.
1 param → 200
PUT
/api/v1/apps/{appId}
Updates the information for a specific app.
1 param body → 200
DELETE
/api/v1/apps/{appId}
Deletes a specific app.
1 param → 200
POST
/api/v1/apps/{appId}/copy
Copies a specific app.
1 param body → 200
GET
/api/v1/apps/{appId}/data/lineage
Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app.
1 param → 200
GET
/api/v1/apps/{appId}/data/metadata
Retrieves the data model and reload statistics metadata of an app. An empty metadata structure is returned if the metadata is not available in the app.
1 param → 200
POST
/api/v1/apps/{appId}/export
Exports a specific app.
2 params → 201400401403404
GET
/api/v1/apps/{appId}/media/files/{path}
Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found.
2 params → 200403404
PUT
/api/v1/apps/{appId}/media/files/{path}
Stores the media content file. Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the suppli…
2 params body → 200403404409
DELETE
/api/v1/apps/{appId}/media/files/{path}
Deletes a media content file or complete directory. Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure o…
2 params → 200403404
GET
/api/v1/apps/{appId}/media/list/{path}
Lists media content. Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
3 params → 200403404
GET
/api/v1/apps/{appId}/media/thumbnail
Gets media content from file currently used as application thumbnail. Returns a stream of bytes containing the media file content on success, or error if file is not found. The image selected as thum…
1 param → 200403404
POST
/api/v1/apps/{appId}/objects/{objectId}/actions/change-owner
Sets owner on an app object. The user must be the owner of the object.
2 params body → 200400404
PUT
/api/v1/apps/{appId}/owner
Changes owner of the app.
1 param body → 200403404
GET
/api/v1/apps/{appId}/placement
Retrieves the app size override for an app.
1 param → 200
PUT
/api/v1/apps/{appId}/placement
Sets the app size override for an app.
1 param body → 200
DELETE
/api/v1/apps/{appId}/placement
Removes the app size override for an app.
1 param → 200
POST
/api/v1/apps/{appId}/publish
Publishes a specific app to a managed space.
1 param body → 200
PUT
/api/v1/apps/{appId}/publish
Republishes a published app to a managed space.
1 param body → 200
GET
/api/v1/apps/{appId}/reloads/logs
Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects.
1 param → 200
GET
/api/v1/apps/{appId}/reloads/logs/{reloadId}
Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".
2 params → 200
GET
/api/v1/apps/{appId}/reloads/metadata/{reloadId}
Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info. Data is available for the last 10 reloads of an appl…
4 params → 200
GET
/api/v1/apps/{appId}/scripts
Retrieves the script history for an app. Returns information about the saved versions of the script in a list sorted with latest first.
4 params → 200
POST
/api/v1/apps/{appId}/scripts
Sets script for an app.
1 param body → 200
GET
/api/v1/apps/{appId}/scripts/{id}
Retrieves a version of the script for an app. Returns the script text.
2 params → 200
PATCH
/api/v1/apps/{appId}/scripts/{id}
Updates a specific version of the script for an app.
2 params body → 200
DELETE
/api/v1/apps/{appId}/scripts/{id}
Deletes a specific version of the script for an app. Fails if the supplied id is the current version.
2 params → 200
PUT
/api/v1/apps/{appId}/space
Sets space on a specific app.
1 param body → 200
DELETE
/api/v1/apps/{appId}/space
Removes space from a specific app.
1 param → 200
POST
/api/v1/apps/import
Imports an app into the system.
7 params body → 200404
GET
/api/v1/apps/privileges
Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.
→ 200
POST
/api/v1/apps/validatescript
Validates the script.
body → 200403
insight-analyses 3
GET
/api/v1/apps/{appId}/insight-analyses
Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields.
getAnalyses 2 params → 200400401404422500
POST
/api/v1/apps/{appId}/insight-analyses/actions/recommend
Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.
getRecommendations 2 params body → 200400401404409422500
GET
/api/v1/apps/{appId}/insight-analyses/model
Returns information about model used to make analysis recommendations. Lists all fields and master items in the logical model, along with an indication of the validity of the logical model if the def…
getBusinessModel 1 param → 200400401404409422500
filters 6
GET
/api/v1/apps/{appId}/report-filters
Get the filter list
filtersList 7 params → 200400401403404429500
POST
/api/v1/apps/{appId}/report-filters
Create a new filter.
filtersCreate 1 param body → 201400401403404409429500
GET
/api/v1/apps/{appId}/report-filters/{id}
Get a filter
filtersGet 3 params → 200400401403404429500
PATCH
/api/v1/apps/{appId}/report-filters/{id}
Update a filter
filtersUpdate 2 params body → 204400401403404409429500
DELETE
/api/v1/apps/{appId}/report-filters/{id}
Delete a filter
filtersDelete 2 params → 204400401403404429500
GET
/api/v1/apps/{appId}/report-filters/actions/count
Get the number of filters for the given app and filter types
filtersCount 2 params → 200400401403404429500
evaluation 6
GET
/api/v1/apps/{guid}/evaluations
Retrieve a list of all historic evaluations for an app GUID
evaluation#getEvaluations 8 params → 200400404500
POST
/api/v1/apps/{guid}/evaluations
Queue an app evaluation
evaluation#queueEvaluation 1 param → 201400403404500
GET
/api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}
Compare two evaluations
evaluation#compareTwo 4 params → 200404500
GET
/api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download
Download a comparison log of two evaluations
evaluation#downloadCompareTwo 2 params → 200404500
GET
/api/v1/apps/evaluations/{id}
Retrieve a specific evaluation
evaluation#getOneEvaluation 3 params → 200404500
GET
/api/v1/apps/evaluations/{id}/actions/download
Download a detailed XML log of a specific evaluation
evaluation#downloadOneEvaluation 1 param → 200404500

Schemas 134

The contract defines 134 schemas that model the data the API accepts and returns. The most detailed are FieldInTableProfilingData (32 properties), comparison (19 properties), NxAttributes (18 properties), ReloadMeta (17 properties). Each schema is shown below with its type and property counts.

Analysis
string
AnalysisComposition
object
6 properties
AnalysisDescriptor
object
6 properties
AnalysisDescriptorResponse
object
2 properties
AnalysisDetails
object
3 properties
AnalysisGroup
string
AnalysisModelItemField
object
4 properties
AnalysisModelItemMasterItem
object
5 properties
AnalysisModelResponse
object
2 properties
AnalysisModelResponseDetail
object
4 properties
AnalysisRecommendationResponse
object
1 property
AnalysisRecommendationResponseDetail
object
2 properties 1 required
AnalysisRecommendRequest
object
Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis. In below examples, conside…
AppAttributes
object
5 properties
AppContentList
object
3 properties
AppContentListItem
object
4 properties
AppObjectGenericType
string
AppUpdateAttributes
object
2 properties
ChartType
string
Chart type given to current recommendation
classification
Classifications
array
classification defines the default role that attribute can play in an analysis
cmpbool
cmpfloat
cmpfloatWithTimeout
cmpint
comparison
object
19 properties
comparisonfields
array
comparisonobjMemoryLimit
array
comparisonobjresponsetime
array
comparisonoobjheavy
array
comparisontables
array
CompositionMinMax
object
Upper and lower bounds for items of specific classification types
2 properties
CreateApp
object
1 property
DataModelMetadata
object
8 properties
EngineGBSize
string
EngineSize
object
Engine size override for app placement on non reload engines.
1 property
Error
object
An error object.
5 properties 2 required
Errors
object
1 property
evaluation
object
16 properties
evaluations
object
2 properties
EvaluatorError
object
1 property
event
object
9 properties
FieldAttributes
object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanism The formatting mechan…
6 properties
FieldAttrType
string
FieldInTableProfilingData
object
32 properties
FieldMetadata
object
15 properties
FieldOverride
object
2 properties
FileData
string
Filter
object
9 properties
FilterError
object
Error occured during the Filter creation.
2 properties 2 required
FilterErrors
object
Errors occured during the Filter creation.
1 property 1 required
FilterField
object
5 properties 1 required
FilterFieldValue
object
3 properties
FilterItemPatch
object
5 properties
FilterList
object
2 properties 2 required
FilterListItem
object
9 properties
FilterRequest
object
7 properties 3 required
FiltersCount
object
1 property
FilterType
string
FilterV1_0
object
2 properties
FilterVariable
object
3 properties 1 required
Float64
number
FrequencyDistributionData
object
3 properties
HardwareMeta
object
2 properties
href
string
Href
object
1 property
JsonObject
object
Contains dynamic JSON data specified by the client.
LastReloadMetadata
object
5 properties
LineageInfoRest
object
2 properties
LinkResponse
object
1 property
Links
object
3 properties
LinksResponse
object
3 properties 3 required
Log
object
1 property
metadata
object
8 properties
NavigationLink
object
1 property
NavigationLinks
object
2 properties
numberFormat
object
6 properties
NxApp
object
Application attributes and user privileges.
3 properties
NxAppCreatePrivileges
object
2 properties
NxAppObject
object
Application object attributes and user privileges.
2 properties
NxAttributes
object
App attributes. This structure can also contain extra user-defined attributes.
18 properties
NxObjectAttributes
object
App object attributes. This structure can also contain extra user-defined attributes.
10 properties
NxPatch
object
3 properties
NxPatchOperationType
string
objectmetrics
object
3 properties
objectspec
object
4 properties
objecttopspec
object
3 properties
PartialNluInfo
object
Contains break down of the asked question in the form of tokens with their classification.
5 properties
PatchFilter
array
PatchFilterItem
object
3 properties 3 required
Placement
object
Override for app placement on non reload engines.
2 properties
PublishApp
object
5 properties
PublishData
string
RecommendedAnalysis
object
RecommendedAnalysisCore
object
4 properties
RecommendFieldItem
object
structure for providing fields in recommendation request, user can retrieve the fields using insight-analyses/model endpoint
2 properties
RecommendItems
object
3 properties
RecommendMasterItem
object
structure for providing master items in recommendation request, user can retrieve the libId of master item using insight-analyses/model endpoint
2 properties
RecommendNaturalLangQuery
object
1 property 1 required
ReloadIncludeFile
object
3 properties
ReloadListMetadata
object
1 property
ReloadMeta
object
17 properties
ReloadStatements
object
11 properties
RepublishApp
object
4 properties
result
object
13 properties
resultentry
resultmetadatatopfields
resultmetadatatoptables
resultobjMemoryLimit
resultobjresponsetime
resultobjsheet
object
3 properties
resultsingle
Script
object
1 property
ScriptIssue
object
5 properties
ScriptIssues
object
2 properties
ScriptLogList
object
1 property
ScriptLogMeta
object
5 properties
ScriptMeta
object
5 properties
ScriptMetaList
object
3 properties
ScriptVersion
object
2 properties
SimplifiedClassifications
array
sortedcomparisonfields
sortedcomparisonobjresponsetime
sortedcomparisonoobjheavy
sortedcomparisontables
SymbolFrequency
object
2 properties
SymbolValue
object
2 properties
TableMetadata
object
9 properties
TableProfilingData
object
2 properties
UpdateApp
object
1 property
UpdateOwner
object
1 property
UpdateSpace
object
1 property
UsageEnum
string
UserPrivileges
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-apps.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Apps API
Qlik Change stores API
Qlik Adaptive cards API
Qlik ODAG apps API
Qlik ODAG links API
Qlik ODAG requests API
Qlik ODAG settings API
Qlik API keys API
Where this information came from

This is an independent, third-party profile of Qlik Apps API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.