Qlik Cloud Apps API. 7 operations published as OpenAPI 3.0.0 at https://qlik.dev/specs/rest/analytics/apps.json
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/analytics-apps-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"info": {
"title": "analytics/apps",
"version": ""
},
"paths": {
"/api/analytics/apps/{appId}/actions/restore": {
"post": {
"summary": "Restore an application",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NxApp_V2"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Not Found"
}
},
"parameters": [
{
"in": "path",
"name": "appId",
"schema": {
"type": "string"
},
"required": true,
"description": "Identifier of the app."
}
],
"description": "Restores a soft-deleted Qlik Cloud Analytics application to the same space with the same app ID, retaining the properties it had at the time of deletion.\nThis operation is available to the app owner and Tenant Admins. The app owner can restore the app only if the original space still exists and they still have delete permission in the space; otherwise, a 403 Forbidden error is returned.\nAssociated resources such as data alerts, subscriptions, collections, notes, and tags are deleted when the app is deleted and cannot be restored.",
"operationId": "restoreApp",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/analytics/apps/{guid}/evaluations": {
"get": {
"tags": [
"evaluation"
],
"summary": "List app evaluations",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/evaluations"
}
}
},
"description": "App evaluations retrieved successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Bad request. The request contains invalid or missing parameters."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Access denied. You lack the required permissions to list evaluations for this app."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "The specified app was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "guid",
"schema": {
"type": "string"
},
"example": "abcdefghijklmnopq",
"required": true,
"description": "The unique identifier of the app."
},
{
"in": "query",
"name": "all",
"schema": {
"type": "boolean"
},
"required": false,
"description": "When `true`, includes full evaluation details in each result. When `false`, detail fields are omitted."
},
{
"in": "query",
"name": "fileMode",
"schema": {
"type": "boolean"
},
"required": false,
"description": "When `true`, adds file download headers to the response."
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string"
},
"required": false,
"description": "The output format for the response. Accepts `json` or `xml`."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": 20,
"maximum": 100,
"minimum": 1
},
"required": false,
"description": "Maximum number of results to return per page."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "A cursor token for fetching the next page of results."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "A cursor token for fetching the previous page of results."
},
{
"in": "query",
"name": "sort",
"schema": {
"enum": [
"started",
"+started",
"-started"
],
"type": "string"
},
"required": false,
"description": "The field to sort results by. Prefix with `-` for descending order or `+` for ascending."
}
],
"description": "Returns a paginated list of historical evaluations for the specified app. Use\nthe `next` and `prev` cursor values from the response links to navigate through\npages of results.\n",
"operationId": "getEvaluations",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-replaces": [
{
"namespace": "",
"uniqueIdentifier": "GET:/v1/apps/{guid}/evaluations"
}
],
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"evaluation"
],
"summary": "Queue an app evaluation",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/evaluation"
}
}
},
"description": "App evaluation queued successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Bad request. The app identifier is missing or invalid."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Access denied. You lack the required permissions to evaluate the app."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "The specified app was not found."
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "The rate limit has been exceeded."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "guid",
"schema": {
"type": "string"
},
"example": "abcdefghijklmnopq",
"required": true,
"description": "The unique identifier of the app to evaluate."
}
],
"description": "Queues a performance and scalability evaluation for the specified app, scheduling\nit for execution by the evaluation engine. The evaluation measures object response\ntimes, CPU usage, document size, and data model metrics. Once queued, use the\nreturned `id` with the retrieval operations to poll for results.\n",
"operationId": "queueEvaluation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/evaluationRequest"
}
}
},
"required": false,
"description": "Optional evaluation settings. The body may be omitted entirely.\n"
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-replaces": [
{
"namespace": "",
"uniqueIdentifier": "POST:/v1/apps/{guid}/evaluations"
}
],
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/analytics/apps/evaluations/{baselineId}/compare/{comparisonId}": {
"get": {
"tags": [
"evaluation"
],
"summary": "Compare two app evaluations",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/comparison"
}
}
},
"description": "Comparison completed successfully."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "One or both of the specified app evaluations were not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "baselineId",
"schema": {
"type": "string"
},
"example": "abcdefghijklmnopq",
"required": true,
"description": "The unique identifier of the baseline app evaluation."
},
{
"in": "path",
"name": "comparisonId",
"schema": {
"type": "string"
},
"example": "abcdefghijklmnopq",
"required": true,
"description": "The unique identifier of the comparison app evaluation."
},
{
"in": "query",
"name": "all",
"schema": {
"type": "boolean"
},
"required": false,
"description": "When `true`, includes all comparison entries regardless of significance."
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string"
},
"required": false,
"description": "The output format for the response. Accepts `json` or `xml`."
}
],
"description": "Compares exactly two app evaluations, a baseline and a comparison, returning a structured\ndiff of performance metrics between them. Use this operation to detect regressions\nafter app changes or engine upgrades. Both evaluations must belong to the same app.\n",
"operationId": "compareTwo",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-replaces": [
{
"namespace": "",
"uniqueIdentifier": "GET:/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}"
}
],
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/analytics/apps/evaluations/{baselineId}/compare/{comparisonId}/actions/download": {
"get": {
"tags": [
"evaluation"
],
"summary": "Download a comparison log",
"responses": {
"200": {
"content": {
"application/xml": {},
"application/json": {
"schema": {
"$ref": "#/components/schemas/comparison"
}
}
},
"description": "Comparison log retrieved successfully."
},
"404": {
"content": {
"application/xml": {},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "One or both of the specified app evaluations were not found."
},
"500": {
"content": {
"application/xml": {},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "baselineId",
"schema": {
"type": "string"
},
"example": "abcdefghijklmnopq",
"required": true,
"description": "The unique identifier of the baseline app evaluation."
},
{
"in": "path",
"name": "comparisonId",
"schema": {
"type": "string"
},
"example": "abcdefghijklmnopq",
"required": true,
"description": "The unique identifier of the comparison app evaluation."
},
{
"in": "header",
"name": "Accept",
"schema": {
"enum": [
"application/xml",
"application/json"
],
"type": "string",
"default": "application/xml"
},
"description": "The desired response format. Accepts `application/xml` (default) or `application/json`."
}
],
"description": "Downloads a comparison log for the two specified app evaluations (baseline and comparison),\ndefaulting to XML format. Use the `Accept` header to request JSON output instead.\nBoth evaluations must belong to the same app.\n",
"operationId": "downloadCompareTwo",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-replaces": [
{
"namespace": "",
"uniqueIdentifier": "GET:/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download"
}
],
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/analytics/apps/evaluations/{id}": {
"get": {
"tags": [
"evaluation"
],
"summary": "Get an app evaluation",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/evaluation"
}
}
},
"description": "App evaluation retrieved successfully."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "The specified app evaluation was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"example": "abcdefghijklmnopq",
"required": true,
"description": "The unique identifier of the app evaluation to retrieve."
},
{
"in": "query",
"name": "all",
"schema": {
"type": "boolean"
},
"required": false,
"description": "When `true`, includes full app evaluation details in the response."
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string"
},
"required": false,
"description": "The output format for the response. Accepts `json` or `xml`."
}
],
"description": "Retrieves a single app evaluation by its unique identifier. Use the `all` parameter\nto include full evaluation details in the response.\n",
"operationId": "getOneEvaluation",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-replaces": [
{
"namespace": "",
"uniqueIdentifier": "GET:/v1/apps/evaluations/{id}"
}
],
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/analytics/apps/evaluations/{id}/actions/download": {
"get": {
"tags": [
"evaluation"
],
"summary": "Download an app evaluation log",
"responses": {
"200": {
"content": {
"application/xml": {},
"application/json": {
"schema": {
"$ref": "#/components/schemas/evaluation"
}
}
},
"description": "App evaluation log retrieved successfully."
},
"404": {
"content": {
"application/xml": {},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "The specified app evaluation was not found."
},
"500": {
"content": {
"application/xml": {},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatorError"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"example": "abcdefghijklmnopq",
"required": true,
"description": "The unique identifier of the app evaluation to download."
},
{
"in": "header",
"name": "Accept",
"schema": {
"enum": [
"application/xml",
"application/json"
],
"type": "string",
"default": "application/xml"
},
"description": "The desired response format. Accepts `application/xml` (default) or `application/json`."
}
],
"description": "Downloads the evaluation log for the specified app evaluation, defaulting to XML\nformat. Use the `Accept` header to request JSON output instead.\n",
"operationId": "downloadOneEvaluation",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-replaces": [
{
"namespace": "",
"uniqueIdentifier": "GET:/v1/apps/evaluations/{id}/actions/download"
}
],
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
}
},
"openapi": "3.0.0",
"components": {
"schemas": {
"classification": {
"allOf": [
{
"type": "object",
"properties": {
"diff": {
"type": "number",
"example": 0.5
},
"trend": {
"type": "string",
"example": "up"
},
"absoluteDiff": {
"type": "number",
"example": 2.5
}
}
}
]
},
"cmpbool": {
"allOf": [
{
"$ref": "#/components/schemas/classification"
},
{
"type": "object",
"properties": {
"baseline": {
"type": "boolean",
"example": false
},
"comparison": {
"type": "boolean",
"example": true
}
}
}
]
},
"cmpEngineSpec": {
"type": "object",
"properties": {
"changed": {
"type": "boolean",
"example": false
},
"baseline": {
"$ref": "#/components/schemas/engineSpec"
},
"comparison": {
"$ref": "#/components/schemas/engineSpec"
}
}
},
"cmpfloat": {
"allOf": [
{
"$ref": "#/components/schemas/classification"
},
{
"type": "object",
"properties": {
"baseline": {
"type": "number",
"example": 1.1
},
"comparison": {
"type": "number",
"example": 2.2
}
}
}
]
},
"cmpfloatWithTimeout": {
"allOf": [
{
"$ref": "#/components/schemas/cmpfloat"
},
{
"type": "object",
"properties": {
"baselineTimeoutStatusCode": {
"type": "string",
"example": "CALC-TIMEOUT"
},
"comparisonTimeoutStatusCode": {
"type": "string",
"example": "CALC-TIMEOUT"
}
}
}
]
},
"cmpint": {
"allOf": [
{
"$ref": "#/components/schemas/classification"
},
{
"type": "object",
"properties": {
"baseline": {
"type": "number",
"example": 1
},
"comparison": {
"type": "number",
"example": 2
}
}
}
]
},
"comparison": {
"type": "object",
"properties": {
"engine": {
"$ref": "#/components/schemas/cmpEngineSpec"
},
"rowCount": {
"$ref": "#/components/schemas/cmpint"
},
"objNoCache": {
"$ref": "#/components/schemas/sortedcomparisonobjresponsetime"
},
"sheetCount": {
"$ref": "#/components/schemas/cmpint"
},
"objectCount": {
"$ref": "#/components/schemas/cmpint"
},
"sheetsCached": {
"$ref": "#/components/schemas/sortedcomparisonobjresponsetime"
},
"objSlowCached": {
"$ref": "#/components/schemas/sortedcomparisonobjresponsetime"
},
"objMemoryLimit": {
"$ref": "#/components/schemas/comparisonobjMemoryLimit"
},
"sheetsUncached": {
"$ref": "#/components/schemas/sortedcomparisonobjresponsetime"
},
"documentSizeMiB": {
"$ref": "#/components/schemas/cmpfloat"
},
"objSlowUncached": {
"$ref": "#/components/schemas/sortedcomparisonobjresponsetime"
},
"hasSectionAccess": {
"$ref": "#/components/schemas/cmpbool"
},
"topFieldsByBytes": {
"$ref": "#/components/schemas/sortedcomparisonfields"
},
"topTablesByBytes": {
"$ref": "#/components/schemas/sortedcomparisontables"
},
"objSingleThreaded": {
"$ref": "#/components/schemas/sortedcomparisonobjresponsetime"
}
}
},
"comparisonfields": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"format": "string",
"example": "a field name"
},
"byteSize": {
"$ref": "#/components/schemas/cmpint"
},
"cardinal": {
"$ref": "#/components/schemas/cmpint"
},
"isSystem": {
"type": "boolean",
"example": false
},
"totalCount": {
"$ref": "#/components/schemas/cmpint"
},
"dataSourceStatus": {
"$ref": "#/components/schemas/dataSourceStatus"
}
}
}
]
},
"maxItems": 2147483647
},
"comparisonobjMemoryLimit": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/objectspec"
},
{
"type": "object",
"properties": {
"dataSourceStatus": {
"$ref": "#/components/schemas/dataSourceStatus"
},
"baselineMemoryLimitStatusCode": {
"type": "string",
"example": "OUT-OF-MEMORY"
},
"comparisonMemoryLimitStatusCode": {
"type": "string",
"example": "OUT-OF-MEMORY"
}
}
}
]
},
"maxItems": 2147483647
},
"comparisonobjresponsetime": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/objectspec"
},
{
"type": "object",
"properties": {
"dataSourceStatus": {
"$ref": "#/components/schemas/dataSourceStatus"
},
"responseTimeSeconds1": {
"$ref": "#/components/schemas/cmpfloatWithTimeout"
},
"responseTimeSeconds2": {
"$ref": "#/components/schemas/cmpfloatWithTimeout"
}
}
}
]
},
"maxItems": 2147483647
},
"comparisontables": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"format": "string",
"example": "a table name"
},
"byteSize": {
"$ref": "#/components/schemas/cmpint"
},
"isSystem": {
"type": "boolean",
"example": false
},
"noOfRows": {
"$ref": "#/components/schemas/cmpint"
},
"dataSourceStatus": {
"$ref": "#/components/schemas/dataSourceStatus"
}
}
}
]
},
"maxItems": 2147483647
},
"dataSourceStatus": {
"enum": [
"full",
"none",
"baselinemissing",
"comparisonmissing"
],
"type": "string",
"example": "full"
},
"engineSpec": {
"type": "object",
"properties": {
"shortName": {
"type": "string",
"example": "OAPE-40"
}
}
},
"ErrorItem": {
"type": "object",
"required": [
"code",
"title"
],
"properties": {
"code": {
"type": "string",
"description": "A unique code for the error."
},
"title": {
"type": "string",
"description": "A human-readable description of the error."
},
"detail": {
"type": "string",
"description": "Additional information about the error."
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorItem"
},
"description": "Array of all errors that occurred during the request."
}
}
},
"evaluation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "string",
"example": "5ecb5e65028d1f0001a98071"
},
"appId": {
"type": "string",
"format": "string",
"example": "7c2ce11d-4d10-4414-a9b0-620e57298038"
},
"ended": {
"type": "string",
"format": "date-time",
"example": "2022-02-09T06:58:40.575Z"
},
"engine": {
"$ref": "#/components/schemas/engineSpec"
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/event"
},
"maxItems": 2147483647
},
"result": {
"$ref": "#/components/schemas/result"
},
"status": {
"type": "string",
"format": "string",
"example": "finished"
},
"appName": {
"type": "string",
"format": "string",
"example": "my app"
},
"details": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"format": "string",
"
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-analytics-apps.json