Apps

Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.

Endpoints

Skip to section

POST	/v1/apps
GET	/v1/apps/{appId}
PUT	/v1/apps/{appId}
DELETE	/v1/apps/{appId}
POST	/v1/apps/{appId}/copy
GET	/v1/apps/{appId}/data/lineage
GET	/v1/apps/{appId}/data/metadata
POST	/v1/apps/{appId}/export
GET	/v1/apps/{appId}/insight-analyses
POST	/v1/apps/{appId}/insight-analyses/actions/recommend
GET	/v1/apps/{appId}/insight-analyses/model
GET	/v1/apps/{appId}/media/files/{path}
PUT	/v1/apps/{appId}/media/files/{path}
DELETE	/v1/apps/{appId}/media/files/{path}
GET	/v1/apps/{appId}/media/list/{path}
GET	/v1/apps/{appId}/media/thumbnail
POST	/v1/apps/{appId}/objects/{objectId}/actions/change-owner
PUT	/v1/apps/{appId}/owner
POST	/v1/apps/{appId}/publish
PUT	/v1/apps/{appId}/publish
GET	/v1/apps/{appId}/reloads/logs
GET	/v1/apps/{appId}/reloads/logs/{reloadId}
GET	/v1/apps/{appId}/reloads/metadata/{reloadId}
GET	/v1/apps/{appId}/scripts
POST	/v1/apps/{appId}/scripts
GET	/v1/apps/{appId}/scripts/{version}
PATCH	/v1/apps/{appId}/scripts/{version}
DELETE	/v1/apps/{appId}/scripts/{version}
PUT	/v1/apps/{appId}/space
DELETE	/v1/apps/{appId}/space
GET	/v1/apps/{guid}/evaluations
POST	/v1/apps/{guid}/evaluations
GET	/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}
GET	/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download
GET	/v1/apps/evaluations/{id}
GET	/v1/apps/evaluations/{id}/actions/download
POST	/v1/apps/import
GET	/v1/apps/privileges

Creates a new app.

manage build

Creates a new app.

Facts POST /v1/apps

Rate limit

required

Tier 2 (100 requests per minute)

Request Body POST /v1/apps

application/json

CreateApp

Attributes that the user wants to set in new app.

Responses POST /v1/apps

200

application/json

NxApp

POST/v1/apps

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"attributes":{"name":"string","usage":"ANALYTICS","locale":"string","spaceId":"string","description":"string"}}'

Request POST /v1/apps

{
  "attributes": {
    "name": "string",
    "usage": "ANALYTICS",
    "locale": "string",
    "spaceId": "string",
    "description": "string"
  }
}

Response POST /v1/apps

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.611Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.611Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.611Z",
    "lastReloadTime": "2023-11-29T00:09:26.611Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Retrieves information for a specific app.

manage build

Retrieves information for a specific app.

Facts GET /v1/apps/{appId}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}

appId

required

string

Identifier of the app.

Responses GET /v1/apps/{appId}

200

application/json

NxApp

GET/v1/apps/{appId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.611Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.611Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.611Z",
    "lastReloadTime": "2023-11-29T00:09:26.611Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Updates the information for a specific app.

manage build

Updates the information for a specific app.

Facts PUT /v1/apps/{appId}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters PUT /v1/apps/{appId}

appId

required

string

Identifier of the app.

Request Body PUT /v1/apps/{appId}

application/json

UpdateApp

Attributes that user wants to set.

Responses PUT /v1/apps/{appId}

200

application/json

NxApp

PUT/v1/apps/{appId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"attributes":{"name":"string","description":"string"}}'

Request PUT /v1/apps/{appId}

{
  "attributes": {
    "name": "string",
    "description": "string"
  }
}

Response PUT /v1/apps/{appId}

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.611Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.611Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.611Z",
    "lastReloadTime": "2023-11-29T00:09:26.611Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Deletes a specific app.

manage build

Deletes a specific app.

Facts DELETE /v1/apps/{appId}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/apps/{appId}

appId

required

string

Identifier of the app.

Responses DELETE /v1/apps/{appId}

200

object

DELETE/v1/apps/{appId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Copies a specific app.

manage build

Copies a specific app.

Facts POST /v1/apps/{appId}/copy

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters POST /v1/apps/{appId}/copy

appId

required

string

Identifier of the app.

Request Body POST /v1/apps/{appId}/copy

application/json

CreateApp

Attributes that should be set in the copy.

Responses POST /v1/apps/{appId}/copy

200

application/json

NxApp

POST/v1/apps/{appId}/copy

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/copy" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"attributes":{"name":"string","usage":"ANALYTICS","locale":"string","spaceId":"string","description":"string"}}'

Request POST /v1/apps/{appId}/copy

{
  "attributes": {
    "name": "string",
    "usage": "ANALYTICS",
    "locale": "string",
    "spaceId": "string",
    "description": "string"
  }
}

Response POST /v1/apps/{appId}/copy

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.611Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.611Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.611Z",
    "lastReloadTime": "2023-11-29T00:09:26.611Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app.

manage build

Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app.

Facts GET /v1/apps/{appId}/data/lineage

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/data/lineage

appId

required

string

Identifier of the app.

Responses GET /v1/apps/{appId}/data/lineage

200

application/json

Array<LineageInfoRest>

GET/v1/apps/{appId}/data/lineage

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/data/lineage" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/data/lineage

[
  {
    "statement": "string",
    "discriminator": "string"
  }
]

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.

manage build

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.

Facts GET /v1/apps/{appId}/data/metadata

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/data/metadata

appId

required

string

Identifier of the app.

Responses GET /v1/apps/{appId}/data/metadata

200

application/json

DataModelMetadata

GET/v1/apps/{appId}/data/metadata

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/data/metadata" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/data/metadata

{
  "usage": "ANALYTICS",
  "fields": [
    {
      "hash": "string",
      "name": "string",
      "tags": [],
      "comment": "string",
      "cardinal": 0,
      "byte_size": 0,
      "is_hidden": true,
      "is_locked": true,
      "is_system": true,
      "is_numeric": true,
      "src_tables": [],
      "is_semantic": true,
      "total_count": 0,
      "distinct_only": true,
      "always_one_selected": true
    }
  ],
  "tables": [
    {
      "name": "string",
      "comment": "string",
      "is_loose": true,
      "byte_size": 0,
      "is_system": true,
      "no_of_rows": 0,
      "is_semantic": true,
      "no_of_fields": 0,
      "no_of_key_fields": 0
    }
  ],
  "reload_meta": {
    "hardware": {
      "total_memory": 0,
      "logical_cores": 0
    },
    "cpu_time_spent_ms": 0,
    "peak_memory_bytes": 0
  },
  "static_byte_size": 0,
  "has_section_access": true,
  "is_direct_query_mode": true,
  "tables_profiling_data": [
    {
      "NoOfRows": 0,
      "FieldProfiling": [
        {
          "Max": 0,
          "Min": 0,
          "Std": 0,
          "Sum": 0,
          "Name": "string",
          "Sum2": 0,
          "Median": 0,
          "Average": 0,
          "Kurtosis": 0,
          "Skewness": 0,
          "FieldTags": [],
          "Fractiles": [],
          "NegValues": 0,
          "PosValues": 0,
          "LastSorted": "string",
          "NullValues": 0,
          "TextValues": 0,
          "ZeroValues": 0,
          "FirstSorted": "string",
          "AvgStringLen": 0,
          "EmptyStrings": 0,
          "MaxStringLen": 0,
          "MinStringLen": 0,
          "MostFrequent": [
            {
              "Symbol": {
                "Text": "string",
                "Number": 0
              },
              "Frequency": 0
            }
          ],
          "NumberFormat": {
            "Dec": "string",
            "Fmt": "string",
            "Thou": "string",
            "Type": "UNKNOWN",
            "nDec": 10,
            "UseThou": 0
          },
          "SumStringLen": 0,
          "NumericValues": 0,
          "DistinctValues": 0,
          "DistinctTextValues": 0,
          "DistinctNumericValues": 0,
          "FrequencyDistribution": {
            "BinsEdges": [],
            "Frequencies": [],
            "NumberOfBins": 0
          }
        }
      ]
    }
  ]
}

Exports a specific app.

manage build

Exports a specific app.

Facts POST /v1/apps/{appId}/export

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters POST /v1/apps/{appId}/export

appId

required

string

Identifier of the app.

Query Parameters POST /v1/apps/{appId}/export

NoData

boolean

The flag indicating if only object contents should be exported.

Responses POST /v1/apps/{appId}/export

201 object	Created
400 object	Bad request
403 object	Forbidden
404 object	Not Found

POST/v1/apps/{appId}/export

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/export" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

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.

manage build

Facts GET /v1/apps/{appId}/insight-analyses

Rate limit

required

Tier 1 (1000 requests per minute)

Header Parameters GET /v1/apps/{appId}/insight-analyses

accept-language

string

language specified as an ISO-639-1 code. Defaults to 'en' (English).

Path Parameters GET /v1/apps/{appId}/insight-analyses

appId

required

string<uid>

Qlik Sense app identifier

Responses GET /v1/apps/{appId}/insight-analyses

200 application/json AnalysisDescriptorResponse	The request is successfully processed and information about supported analyses is returned.
400 application/json Errors	Bad request. The payload is not formed correctly.
401 application/json Errors	User is not authorized
404 application/json Errors	Not found
422 application/json Errors	Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.
500 application/json Errors	Internal server error

GET/v1/apps/{appId}/insight-analyses

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/insight-analyses" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/insight-analyses

{
  "data": [
    {
      "id": "string",
      "compositions": [
        {
          "dims": {
            "max": 0,
            "min": 0
          },
          "geos": {
            "max": 0,
            "min": 0
          },
          "msrs": {
            "max": 0,
            "min": 0
          },
          "items": {
            "max": 0,
            "min": 0
          },
          "temporals": {
            "max": 0,
            "min": 0
          },
          "description": {
            "long": "string",
            "short": "string"
          }
        }
      ],
      "supportsMasterItems": true,
      "requiresAutoCalendarPeriod": true,
      "requiresDefinedAnalysisPeriod": true,
      "requiresAvailableAnalysisPeriod": true
    }
  ],
  "links": {
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}

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.

manage build

Facts POST /v1/apps/{appId}/insight-analyses/actions/recommend

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters POST /v1/apps/{appId}/insight-analyses/actions/recommend

accept-language

string

language specified as an ISO-639-1 code. Defaults to 'en' (English).

Path Parameters POST /v1/apps/{appId}/insight-analyses/actions/recommend

appId

required

string<uid>

Qlik Sense app identifier

Request Body POST /v1/apps/{appId}/insight-analyses/actions/recommend

application/json

oneOf

No description

Responses POST /v1/apps/{appId}/insight-analyses/actions/recommend

200 application/json AnalysisRecommendationResponse	The request is successfully processed and recommendations are returned.
400 application/json Errors	Bad request. The payload is not formed correctly.
401 application/json Errors	User is not authorized
404 application/json Errors	Not found
409 application/json Errors	Invalid Business Logic
422 application/json Errors	Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.
500 application/json Errors	Internal server error

POST/v1/apps/{appId}/insight-analyses/actions/recommend

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/insight-analyses/actions/recommend" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json"

Response POST /v1/apps/{appId}/insight-analyses/actions/recommend

{
  "data": [
    {
      "nluInfo": [
        {
          "role": "dimension",
          "text": "string",
          "type": "field",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ],
      "recAnalyses": [
        {
          "options": {},
          "analysis": {
            "title": "string",
            "analysis": "breakdown",
            "analysisGroup": "anomaly"
          },
          "chartType": "barchart",
          "relevance": 0,
          "parts": [
            {
              "options": {},
              "analysis": {
                "title": "string",
                "analysis": "breakdown",
                "analysisGroup": "anomaly"
              },
              "chartType": "barchart",
              "relevance": 0
            }
          ]
        }
      ]
    }
  ]
}

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 default is not used.

manage build

Facts GET /v1/apps/{appId}/insight-analyses/model

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/insight-analyses/model

appId

required

string<uid>

Qlik Sense app identifier

Responses GET /v1/apps/{appId}/insight-analyses/model

200 application/json AnalysisModelResponse	The request is successfully processed and information about model is returned.
400 application/json Errors	Bad request. The payload is not formed correctly.
401 application/json Errors	User is not authorized
404 application/json Errors	Not found
409 application/json Errors	Invalid Business Logic
422 application/json Errors	Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.
500 application/json Errors	Internal server error

GET/v1/apps/{appId}/insight-analyses/model

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/insight-analyses/model" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/insight-analyses/model

{
  "data": [
    {
      "fields": [
        {
          "name": "string",
          "isHidden": true,
          "classifications": [],
          "simplifiedClassifications": []
        }
      ],
      "masterItems": [
        {
          "libId": "string",
          "caption": "string",
          "isHidden": true,
          "classifications": [],
          "simplifiedClassifications": []
        }
      ],
      "isLogicalModelEnabled": true,
      "isDefinedLogicalModelValid": true
    }
  ],
  "links": {
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}

Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found.

manage build

Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found.

Facts GET /v1/apps/{appId}/media/files/{path}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/media/files/{path}

appId required string	Unique application identifier.
path required string	Path to file content.

Responses GET /v1/apps/{appId}/media/files/{path}

200 application/octet-stream string<binary>	OK
403 object	Forbidden
404 object	Not Found

GET/v1/apps/{appId}/media/files/{path}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/media/files/{path}

{
  "undefined": "string"
}

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 supplied path.

manage build

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 supplied path.

Facts PUT /v1/apps/{appId}/media/files/{path}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters PUT /v1/apps/{appId}/media/files/{path}

appId required string	Unique application identifier.
path required string	Path to file content.

Request Body PUT /v1/apps/{appId}/media/files/{path}

application/octet-stream

FileData

No description

Responses PUT /v1/apps/{appId}/media/files/{path}

200 object	OK
403 object	Forbidden
404 object	Not Found

PUT/v1/apps/{appId}/media/files/{path}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/octet-stream" \
 --data-binary "@/path/to/file"

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 or lack of permission.

manage build

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 or lack of permission.

Facts DELETE /v1/apps/{appId}/media/files/{path}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/apps/{appId}/media/files/{path}

appId required string	Unique application identifier.
path required string	Path to file content.

Responses DELETE /v1/apps/{appId}/media/files/{path}

200 object	OK
403 object	Forbidden
404 object	Not Found

DELETE/v1/apps/{appId}/media/files/{path}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

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.

manage build

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.

Facts GET /v1/apps/{appId}/media/list/{path}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/media/list/{path}

appId required string	Unique application identifier.
path required string	The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.

Query Parameters GET /v1/apps/{appId}/media/list/{path}

show

string

Optional. List output can include files and folders in different ways:

Not recursive, default if show option is not supplied or incorrectly specified, results in output with files and empty directories for the path specified only.
Recursive(r), use ?show=r or ?show=recursive, results in a recursive output with files, all empty folders are excluded.
All(a), use ?show=a or ?show=all, results in a recursive output with files and empty directories.

Responses GET /v1/apps/{appId}/media/list/{path}

200 application/json AppContentList	OK
403 object	Forbidden
404 object	Not Found

GET/v1/apps/{appId}/media/list/{path}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/list/{path}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/media/list/{path}

{
  "data": [
    {
      "id": "string",
      "link": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "library": "string",
  "subpath": "string"
}

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 thumbnail is only updated when application is saved.

manage build

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 thumbnail is only updated when application is saved.

Facts GET /v1/apps/{appId}/media/thumbnail

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/media/thumbnail

appId

required

string

Unique application identifier.

Responses GET /v1/apps/{appId}/media/thumbnail

200 application/octet-stream string<binary>	OK
403 object	Forbidden
404 object	Not Found

GET/v1/apps/{appId}/media/thumbnail

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/thumbnail" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/media/thumbnail

{
  "undefined": "string"
}

Sets owner on an app object. The user must be the owner of the object.

manage build

Sets owner on an app object. The user must be the owner of the object.

Facts POST /v1/apps/{appId}/objects/{objectId}/actions/change-owner

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters POST /v1/apps/{appId}/objects/{objectId}/actions/change-owner

appId required string	Identifier of the app.
objectId required string	Identifier of the object.

Request Body POST /v1/apps/{appId}/objects/{objectId}/actions/change-owner

application/json

UpdateOwner

New owner.

Responses POST /v1/apps/{appId}/objects/{objectId}/actions/change-owner

200 application/json NxAppObject	OK
400 object	Bad request
404 object	Not Found

POST/v1/apps/{appId}/objects/{objectId}/actions/change-owner

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/objects/{objectId}/actions/change-owner" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"ownerId":"string"}'

Request POST /v1/apps/{appId}/objects/{objectId}/actions/change-owner

{
  "ownerId": "string"
}

Response POST /v1/apps/{appId}/objects/{objectId}/actions/change-owner

{
  "attributes": {
    "id": "string",
    "name": "string",
    "ownerId": "string",
    "approved": true,
    "createdAt": "2023-11-29T00:09:26.613Z",
    "updatedAt": "2023-11-29T00:09:26.613Z",
    "objectType": "string",
    "description": "string",
    "genericType": "genericObject",
    "publishedAt": "2023-11-29T00:09:26.613Z"
  },
  "privileges": []
}

Changes owner of the app.

manage build

Changes owner of the app.

Facts PUT /v1/apps/{appId}/owner

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters PUT /v1/apps/{appId}/owner

appId

required

string

Identifier of the app.

Request Body PUT /v1/apps/{appId}/owner

application/json

UpdateOwner

New owner.

Responses PUT /v1/apps/{appId}/owner

200 application/json NxApp	OK
403 object	Forbidden
404 object	Not Found

PUT/v1/apps/{appId}/owner

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/owner" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"ownerId":"string"}'

Request PUT /v1/apps/{appId}/owner

{
  "ownerId": "string"
}

Response PUT /v1/apps/{appId}/owner

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.613Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.613Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.613Z",
    "lastReloadTime": "2023-11-29T00:09:26.613Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Publishes a specific app to a managed space.

manage build

Publishes a specific app to a managed space.

Facts POST /v1/apps/{appId}/publish

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters POST /v1/apps/{appId}/publish

appId

required

string

Identifier of the app.

Request Body POST /v1/apps/{appId}/publish

application/json

PublishApp

Publish information for the app.

Responses POST /v1/apps/{appId}/publish

200

application/json

NxApp

POST/v1/apps/{appId}/publish

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/publish" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"data":"source","moveApp":true,"spaceId":"string","attributes":{"name":"string","description":"string"},"originAppId":"string"}'

Request POST /v1/apps/{appId}/publish

{
  "data": "source",
  "moveApp": true,
  "spaceId": "string",
  "attributes": {
    "name": "string",
    "description": "string"
  },
  "originAppId": "string"
}

Response POST /v1/apps/{appId}/publish

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.613Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.613Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.613Z",
    "lastReloadTime": "2023-11-29T00:09:26.613Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Republishes a published app to a managed space.

manage build

Republishes a published app to a managed space.

Facts PUT /v1/apps/{appId}/publish

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters PUT /v1/apps/{appId}/publish

appId

required

string

Identifier of the app.

Request Body PUT /v1/apps/{appId}/publish

application/json

RepublishApp

Republish information for the app.

Responses PUT /v1/apps/{appId}/publish

200

application/json

NxApp

PUT/v1/apps/{appId}/publish

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/publish" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"data":"source","targetId":"string","attributes":{"name":"string","description":"string"},"checkOriginAppId":true}'

Request PUT /v1/apps/{appId}/publish

{
  "data": "source",
  "targetId": "string",
  "attributes": {
    "name": "string",
    "description": "string"
  },
  "checkOriginAppId": true
}

Response PUT /v1/apps/{appId}/publish

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.613Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.613Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.613Z",
    "lastReloadTime": "2023-11-29T00:09:26.613Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects.

manage build

Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects.

Facts GET /v1/apps/{appId}/reloads/logs

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/reloads/logs

appId

required

string

Identifier of the app.

Responses GET /v1/apps/{appId}/reloads/logs

200

application/json

ScriptLogList

GET/v1/apps/{appId}/reloads/logs

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/reloads/logs" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/reloads/logs

{
  "data": [
    {
      "links": {
        "log": "string"
      },
      "endTime": "2023-11-29T00:09:26.613Z",
      "success": true,
      "duration": 0,
      "reloadId": "string"
    }
  ]
}

Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".

manage build

Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".

Facts GET /v1/apps/{appId}/reloads/logs/{reloadId}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/reloads/logs/{reloadId}

appId required string	Identifier of the app.
reloadId required string	Identifier of the reload.

Responses GET /v1/apps/{appId}/reloads/logs/{reloadId}

200

application/octet-stream

string<binary>

GET/v1/apps/{appId}/reloads/logs/{reloadId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/reloads/logs/{reloadId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/reloads/logs/{reloadId}

{
  "undefined": "string"
}

Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.

manage

Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.

Facts GET /v1/apps/{appId}/reloads/metadata/{reloadId}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/reloads/metadata/{reloadId}

appId required string	Identifier of the app
reloadId required string	Identifier of the reload. Use empty reloadId to get all reloads.

Query Parameters GET /v1/apps/{appId}/reloads/metadata/{reloadId}

limit

string

Maximum number of records to return from this request. Default: 100

Responses GET /v1/apps/{appId}/reloads/metadata/{reloadId}

200

application/json

ReloadListMetadata

GET/v1/apps/{appId}/reloads/metadata/{reloadId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/reloads/metadata/{reloadId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/reloads/metadata/{reloadId}

{
  "data": [
    {
      "endTime": "2023-11-29T00:09:26.613Z",
      "success": true,
      "duration": 0,
      "reloadId": "string",
      "rowLimit": -1,
      "skipStore": true,
      "statements": [
        {
          "qri": "string",
          "type": "string",
          "label": "string",
          "dataSize": 0,
          "duration": 0,
          "nbrOfRows": 0,
          "tableName": "string",
          "connection": "string",
          "nbrOfFields": 0,
          "connectionId": "string",
          "partialReloadOperation": "string"
        }
      ],
      "loadFilesBytes": 0,
      "isPartialReload": true,
      "storeFilesBytes": 0,
      "loadExternalBytes": 0,
      "loadDataFilesBytes": 0,
      "storeDataFilesBytes": 0
    }
  ]
}

Retrieves the script history for an app. Returns information about the saved versions of the script.

manage build

Retrieves the script history for an app. Returns information about the saved versions of the script.

Facts GET /v1/apps/{appId}/scripts

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/scripts

appId

required

string

Identifier of the app.

Query Parameters GET /v1/apps/{appId}/scripts

filter string	A scim filter expression defining which script versions should be retrieved. Filterable fields are: ScriptId ModifiedTime ModifierId
limit string	Maximum number of records to return from this request.
page string	Opaque definition of which page of the result set to return. Returned from a previous call using the same filter. Not yet supported.

Responses GET /v1/apps/{appId}/scripts

200

application/json

ScriptMetaList

GET/v1/apps/{appId}/scripts

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/scripts

{
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  },
  "scripts": [
    {
      "size": 0,
      "scriptId": "string",
      "modifierId": "string",
      "modifiedTime": "string",
      "versionMessage": "string"
    }
  ]
}

Sets script for an app.

manage build

Sets script for an app.

Facts POST /v1/apps/{appId}/scripts

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters POST /v1/apps/{appId}/scripts

appId

required

string

Identifier of the app.

Request Body POST /v1/apps/{appId}/scripts

application/json

ScriptVersion

The script to set.

Responses POST /v1/apps/{appId}/scripts

200

object

POST/v1/apps/{appId}/scripts

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"script":"string","versionMessage":"string"}'

Request POST /v1/apps/{appId}/scripts

{
  "script": "string",
  "versionMessage": "string"
}

Retrieves a version of the script for an app. Returns the script text.

manage build

Retrieves a version of the script for an app. Returns the script text.

Facts GET /v1/apps/{appId}/scripts/{version}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{appId}/scripts/{version}

appId required string	Identifier of the app.
version required string	Identifier of the script version, or 'current' for retrieving the current version.

Responses GET /v1/apps/{appId}/scripts/{version}

200

application/json

ScriptVersion

GET/v1/apps/{appId}/scripts/{version}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts/{version}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{appId}/scripts/{version}

{
  "script": "string",
  "versionMessage": "string"
}

Updates a specific version of the script for an app.

manage build

Updates a specific version of the script for an app.

Facts PATCH /v1/apps/{appId}/scripts/{version}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters PATCH /v1/apps/{appId}/scripts/{version}

appId required string	Identifier of the app.
version required string	Identifier of the script version.

Request Body PATCH /v1/apps/{appId}/scripts/{version}

application/json

NxPatch

Array of patches for the object ScriptVersion.

<div class=note>Only /versionMessage can be modified using operations add, remove and replace.</div>

Responses PATCH /v1/apps/{appId}/scripts/{version}

200

object

PATCH/v1/apps/{appId}/scripts/{version}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts/{version}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"Op":"Add","Path":"string","Value":"string"}'

Request PATCH /v1/apps/{appId}/scripts/{version}

{
  "Op": "Add",
  "Path": "string",
  "Value": "string"
}

Deletes a specific version of the script for an app. Fails if the version to delete is the current version.

manage build

Deletes a specific version of the script for an app. Fails if the version to delete is the current version.

Facts DELETE /v1/apps/{appId}/scripts/{version}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/apps/{appId}/scripts/{version}

appId required string	Identifier of the app.
version required string	Identifier of the script version

Responses DELETE /v1/apps/{appId}/scripts/{version}

200

object

DELETE/v1/apps/{appId}/scripts/{version}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts/{version}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Sets space on a specific app.

manage build

Sets space on a specific app.

Facts PUT /v1/apps/{appId}/space

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters PUT /v1/apps/{appId}/space

appId

required

string

Identifier of the app.

Request Body PUT /v1/apps/{appId}/space

application/json

UpdateSpace

New space.

Responses PUT /v1/apps/{appId}/space

200

application/json

NxApp

PUT/v1/apps/{appId}/space

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/space" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"spaceId":"string"}'

Request PUT /v1/apps/{appId}/space

{
  "spaceId": "string"
}

Response PUT /v1/apps/{appId}/space

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.613Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.613Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.613Z",
    "lastReloadTime": "2023-11-29T00:09:26.613Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Removes space from a specific app.

manage build

Removes space from a specific app.

Facts DELETE /v1/apps/{appId}/space

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/apps/{appId}/space

appId

required

string

Identifier of the app.

Responses DELETE /v1/apps/{appId}/space

200

application/json

NxApp

DELETE/v1/apps/{appId}/space

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/space" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Response DELETE /v1/apps/{appId}/space

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.613Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.613Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.613Z",
    "lastReloadTime": "2023-11-29T00:09:26.613Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Retrieve a list of all historic evaluations for an app GUID

manage build

Find all evaluations for an app GUID. Supports paging via next, prev which are sent in the response body

Facts GET /v1/apps/{guid}/evaluations

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/{guid}/evaluations

guid

required

string

The app guid.

Query Parameters GET /v1/apps/{guid}/evaluations

all boolean	Get the full data of the evaluation
fileMode boolean	Add file transfer headers to response
format string	Specify output format, currently supported are 'json' and 'xml'
limit default=20, minimum=1, maximum=100 integer<int32>	Number of results to return per page.
next string	The app evaluation id to get next page from
prev string	The app evaluation id to get previous page from
sort string	Property to sort list on

Responses GET /v1/apps/{guid}/evaluations

200 application/json evaluations	Evaluation(s) retrieved successfully.
400 application/json EvaluatorError	Bad request.
404 application/json EvaluatorError	Not Found.
500 application/json EvaluatorError	Internal server error.

GET/v1/apps/{guid}/evaluations

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{guid}/evaluations" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/{guid}/evaluations

{
  "data": [
    {
      "id": "5ecb5e65028d1f0001a98071",
      "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
      "ended": "2022-02-09T06:58:40.575Z",
      "events": [
        {
          "details": "An object failed",
          "sheetId": "gregFG",
          "objectId": "adfRFr",
          "severity": "warning",
          "errorCode": "ERR-GOPHERCISER",
          "objectType": "linechart",
          "sheetTitle": "mysheet",
          "objectTitle": "profit",
          "objectVisualization": "linechart"
        }
      ],
      "result": {
        "sheets": [
          {
            "sheet": {
              "id": "fjETFn",
              "title": "my chart",
              "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
              "objectType": 1,
              "responseTimeSeconds": 12.3
            },
            "objectCount": 1,
            "sheetObjects": [
              {
                "id": "fjETFn",
                "title": "my chart",
                "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
                "objectType": 1,
                "responseTimeSeconds": 12.3
              }
            ]
          }
        ],
        "rowCount": 20000,
        "objNoCache": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds": 12.3
          }
        ],
        "sheetCount": 5,
        "objectCount": 33,
        "objSlowCached": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "schema": {
              "id": "fjETFn",
              "title": "my chart",
              "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
              "objectType": 1
            },
            "cpuQuotients": [],
            "responseTimeSeconds": 12.3
          }
        ],
        "documentSizeMiB": 12.3,
        "objSlowUncached": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds": 12.3
          }
        ],
        "hasSectionAccess": true,
        "topFieldsByBytes": [
          {
            "name": "a",
            "byte_size": 1234,
            "is_system": true
          }
        ],
        "topTablesByBytes": [
          {
            "name": "a",
            "byte_size": 1234,
            "is_system": true
          }
        ],
        "objSingleThreaded": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "cpuQuotient1": 12.3
          }
        ]
      },
      "status": "finished",
      "appName": "my app",
      "details": {
        "errors": [],
        "warnings": [],
        "dedicated": true,
        "objectMetrics": {},
        "engineHasCache": true,
        "concurrentReload": true
      },
      "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "started": "2022-02-09T06:58:40.575Z",
      "version": 1,
      "metadata": {
        "reloadmeta": {
          "cpuspent": "123983",
          "peakmemorybytes": 112
        },
        "amountofrows": 1423423234,
        "amountoffields": 12,
        "amountoftables": 7,
        "staticbytesize": 1444234,
        "hassectionaccess": true,
        "amountoffieldvalues": 144423433,
        "amountofcardinalfieldvalues": 14442
      },
      "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "timestamp": "2022-02-09T06:58:40.575Z",
      "sheetTitle": "my sheet"
    }
  ],
  "links": {
    "next": {
      "href": "/api/v1/evaluations/appId=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35"
    },
    "prev": {
      "href": "/api/v1/evaluations/appId=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35"
    }
  }
}

Queue an app evaluation

manage build

Queue an app evaluation by its app guid.

Facts POST /v1/apps/{guid}/evaluations

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters POST /v1/apps/{guid}/evaluations

guid

required

string

Guid of the app.

Responses POST /v1/apps/{guid}/evaluations

201 application/json evaluation	App evaluation queued.
400 application/json EvaluatorError	Bad request, incorrect body.
403 application/json EvaluatorError	User lacks permissions to evaluate app.
404 application/json EvaluatorError	App does not exist.
500 application/json EvaluatorError	Internal server error.

POST/v1/apps/{guid}/evaluations

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{guid}/evaluations" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Response POST /v1/apps/{guid}/evaluations

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {
      "details": "An object failed",
      "sheetId": "gregFG",
      "objectId": "adfRFr",
      "severity": "warning",
      "errorCode": "ERR-GOPHERCISER",
      "objectType": "linechart",
      "sheetTitle": "mysheet",
      "objectTitle": "profit",
      "objectVisualization": "linechart"
    }
  ],
  "result": {
    "sheets": [
      {
        "sheet": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1,
          "responseTimeSeconds": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds": 12.3
          }
        ]
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds": 12.3
      }
    ],
    "sheetCount": 5,
    "objectCount": 33,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "schema": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1
        },
        "cpuQuotients": [],
        "responseTimeSeconds": 12.3
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds": 12.3
      }
    ],
    "hasSectionAccess": true,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuQuotient1": 12.3
      }
    ]
  },
  "status": "finished",
  "appName": "my app",
  "details": {
    "errors": [],
    "warnings": [],
    "dedicated": true,
    "objectMetrics": {},
    "engineHasCache": true,
    "concurrentReload": true
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "started": "2022-02-09T06:58:40.575Z",
  "version": 1,
  "metadata": {
    "reloadmeta": {
      "cpuspent": "123983",
      "peakmemorybytes": 112
    },
    "amountofrows": 1423423234,
    "amountoffields": 12,
    "amountoftables": 7,
    "staticbytesize": 1444234,
    "hassectionaccess": true,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

Compare two evaluations

manage build

Accepts two evaluation ids and returns a comparison denoting the differences between the two.

Facts GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}

baseid required string	Id of the baseline evaluation
comparisonid required string	Id of the comparison evaluation

Query Parameters GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}

all boolean	Get the full list of comparisons including non-significant diffs
format string	Specify output format, currently supported are 'json' and 'xml'

Responses GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}

200 application/json comparison	Comparison executed successfully.
404 application/json EvaluatorError	Not Found.
500 application/json EvaluatorError	Internal server error.

GET/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}

{
  "objHeavy": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "rowCount": {
    "baseline": 1,
    "comparison": 2
  },
  "objNoCache": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "sheetCount": {
    "baseline": 1,
    "comparison": 2
  },
  "fileSizeMib": {
    "baseline": 1.1,
    "comparison": 2.2
  },
  "objectCount": {
    "baseline": 1,
    "comparison": 2
  },
  "maxMemoryMib": {
    "baseline": 1.1,
    "comparison": 2.2
  },
  "sheetsCached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "objSlowCached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "sheetsUncached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "documentSizeMib": {
    "baseline": 1.1,
    "comparison": 2.2
  },
  "objSlowUncached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "dataModelSizeMib": {
    "baseline": 1.1,
    "comparison": 2.2
  },
  "hasSectionAccess": {
    "baseline": true,
    "comparison": true
  },
  "topFieldsByBytes": {
    "list": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "topTablesByBytes": {
    "list": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "objSingleThreaded": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "appOpenTimeSeconds": {
    "baseline": 1.1,
    "comparison": 2.2
  }
}

Download a comparison log of two evaluations

manage build

Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.

Facts GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download

baseid required string	Id of the baseline evaluation
comparisonid required string	Id of the comparison evaluation

Responses GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download

200 application/json comparison	Comparison executed successfully.
404 application/json EvaluatorError	Not Found.
500 application/json EvaluatorError	Internal server error.

GET/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download

{
  "objHeavy": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "rowCount": {
    "baseline": 1,
    "comparison": 2
  },
  "objNoCache": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "sheetCount": {
    "baseline": 1,
    "comparison": 2
  },
  "fileSizeMib": {
    "baseline": 1.1,
    "comparison": 2.2
  },
  "objectCount": {
    "baseline": 1,
    "comparison": 2
  },
  "maxMemoryMib": {
    "baseline": 1.1,
    "comparison": 2.2
  },
  "sheetsCached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "objSlowCached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "sheetsUncached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "documentSizeMib": {
    "baseline": 1.1,
    "comparison": 2.2
  },
  "objSlowUncached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "dataModelSizeMib": {
    "baseline": 1.1,
    "comparison": 2.2
  },
  "hasSectionAccess": {
    "baseline": true,
    "comparison": true
  },
  "topFieldsByBytes": {
    "list": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "cardinal": {
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "topTablesByBytes": {
    "list": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "baseline": true,
          "comparison": true
        },
        "no_of_rows": {
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "objSingleThreaded": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "baseline": 1.1,
          "comparison": 2.2
        },
        "responseTimeSeconds2": {
          "baseline": 1.1,
          "comparison": 2.2
        }
      }
    ]
  },
  "appOpenTimeSeconds": {
    "baseline": 1.1,
    "comparison": 2.2
  }
}

Retrieve a specific evaluation

manage build

Find an evaluation by a specific id.

Facts GET /v1/apps/evaluations/{id}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/evaluations/{id}

required

string

Id of the desired evaluation.

Query Parameters GET /v1/apps/evaluations/{id}

all boolean	Get the full data of the evaluation
format string	Specify output format, currently supported are 'json' and 'xml'

Responses GET /v1/apps/evaluations/{id}

200 application/json evaluation	Evaluation(s) retrieved successfully.
404 application/json EvaluatorError	Not Found.
500 application/json EvaluatorError	Internal server error.

GET/v1/apps/evaluations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/evaluations/{id}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/evaluations/{id}

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {
      "details": "An object failed",
      "sheetId": "gregFG",
      "objectId": "adfRFr",
      "severity": "warning",
      "errorCode": "ERR-GOPHERCISER",
      "objectType": "linechart",
      "sheetTitle": "mysheet",
      "objectTitle": "profit",
      "objectVisualization": "linechart"
    }
  ],
  "result": {
    "sheets": [
      {
        "sheet": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1,
          "responseTimeSeconds": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds": 12.3
          }
        ]
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds": 12.3
      }
    ],
    "sheetCount": 5,
    "objectCount": 33,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "schema": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1
        },
        "cpuQuotients": [],
        "responseTimeSeconds": 12.3
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds": 12.3
      }
    ],
    "hasSectionAccess": true,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuQuotient1": 12.3
      }
    ]
  },
  "status": "finished",
  "appName": "my app",
  "details": {
    "errors": [],
    "warnings": [],
    "dedicated": true,
    "objectMetrics": {},
    "engineHasCache": true,
    "concurrentReload": true
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "started": "2022-02-09T06:58:40.575Z",
  "version": 1,
  "metadata": {
    "reloadmeta": {
      "cpuspent": "123983",
      "peakmemorybytes": 112
    },
    "amountofrows": 1423423234,
    "amountoffields": 12,
    "amountoftables": 7,
    "staticbytesize": 1444234,
    "hassectionaccess": true,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

Download a detailed XML log of a specific evaluation

manage build

Find and download an evaluation log by a specific evaluation id.

Facts GET /v1/apps/evaluations/{id}/actions/download

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/apps/evaluations/{id}/actions/download

required

string

Id of the desired evaluation.

Responses GET /v1/apps/evaluations/{id}/actions/download

200 application/json evaluation	Evaluation(s) retrieved successfully.
404 application/json EvaluatorError	Not Found.
500 application/json EvaluatorError	Internal server error.

GET/v1/apps/evaluations/{id}/actions/download

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/evaluations/{id}/actions/download" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/evaluations/{id}/actions/download

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {
      "details": "An object failed",
      "sheetId": "gregFG",
      "objectId": "adfRFr",
      "severity": "warning",
      "errorCode": "ERR-GOPHERCISER",
      "objectType": "linechart",
      "sheetTitle": "mysheet",
      "objectTitle": "profit",
      "objectVisualization": "linechart"
    }
  ],
  "result": {
    "sheets": [
      {
        "sheet": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1,
          "responseTimeSeconds": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": 1,
            "responseTimeSeconds": 12.3
          }
        ]
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds": 12.3
      }
    ],
    "sheetCount": 5,
    "objectCount": 33,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "schema": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1
        },
        "cpuQuotients": [],
        "responseTimeSeconds": 12.3
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "responseTimeSeconds": 12.3
      }
    ],
    "hasSectionAccess": true,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": true
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuQuotient1": 12.3
      }
    ]
  },
  "status": "finished",
  "appName": "my app",
  "details": {
    "errors": [],
    "warnings": [],
    "dedicated": true,
    "objectMetrics": {},
    "engineHasCache": true,
    "concurrentReload": true
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "started": "2022-02-09T06:58:40.575Z",
  "version": 1,
  "metadata": {
    "reloadmeta": {
      "cpuspent": "123983",
      "peakmemorybytes": 112
    },
    "amountofrows": 1423423234,
    "amountoffields": 12,
    "amountoftables": 7,
    "staticbytesize": 1444234,
    "hassectionaccess": true,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

Imports an app into the system.

manage build

Imports an app into the system.

Facts POST /v1/apps/import

Rate limit

required

Tier 2 (100 requests per minute)

Query Parameters POST /v1/apps/import

appId string	The app ID of the target app when source is qvw file.
fallbackName string	The name of the target app when source does not have a specified name, applicable if source is qvw file.
fileId string	The file ID to be downloaded from Temporary Content Service (TCS) and used during import.
mode string	The import mode. In `new` mode (default), the source app will be imported as a new app.<div class=note>The `autoreplace` mode is an internal mode only and is not permitted for external use.</div> One of: NEW AUTOREPLACE Enum: NEW AUTOREPLACE
name string	The name of the target app.
NoData boolean	If NoData is true, the data of the existing app will be kept as is, otherwise it will be replaced by the new incoming data.
spaceId string	The space ID of the target app.

Request Body POST /v1/apps/import

application/octet-stream

FileData

Path of the source app.

Responses POST /v1/apps/import

200 application/json NxApp	OK
404 object	Not Found

POST/v1/apps/import

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/import" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/octet-stream" \
 --data-binary "@/path/to/file"

Response POST /v1/apps/import

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "usage": "ANALYTICS",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2023-11-29T00:09:26.616Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2023-11-29T00:09:26.616Z",
    "dynamicColor": "string",
    "modifiedDate": "2023-11-29T00:09:26.616Z",
    "lastReloadTime": "2023-11-29T00:09:26.616Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "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.

manage build

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.

Facts GET /v1/apps/privileges

Rate limit

required

Tier 1 (1000 requests per minute)

Responses GET /v1/apps/privileges

200

application/json

Array<string>

GET/v1/apps/privileges

curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/privileges" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/apps/privileges

{
  "items": "string"
}

UpdateOwner

object

Properties

ownerId

string

No description

Analysis

string

Enum:

breakdown

changePoint

comparison

contribution

correlation

fact

mutualInfo

rank

spike

trend

title

string

No description

analysis

Analysis

No description

Enum:

breakdown

changePoint

comparison

contribution

correlation

fact

mutualInfo

rank

spike

trend

values

analysisGroup

AnalysisGroup

No description

Enum:

anomaly

brekadown

comparison

correl

fact

list

mutualInfo

rank

AnalysisGroup

string

Enum:

anomaly

brekadown

comparison

correl

fact

list

mutualInfo

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, consider sales as a master item and product as field, so to get recommendations using sales and product, you can utilize below three approaches, also you can set language parameter in headers as part of accept-language. Examples:

{
  "text": "show me sales by product"
}

{
  "fields": [
    {
      "name": "product"
    }
  ],
  "libItems": [
    {
      libId: "NwQfJ"
    }
  ]
}

{
  "fields": [
    {
      "name": "product"
    }
  ],
  "libItems": [
    {
      "libId": "NwQfJ"
    }
  ],
  "targetAnalysis": {
    "id": "rank-rank"
  }
}

oneOf

RecommendNaturalLangQuery	No description
RecommendItems	No description

AppAttributes

object

Properties

name string	The name (title) of the application
usage string	Indicates whether the app is used for Analytics or DataPreparation One of: ANALYTICS DATA_PREPARATION Enum: ANALYTICS DATA_PREPARATION
locale string	Set custom locale instead of the system default
spaceId string	The space ID of the application
description string	The description of the application

AppContentList

object

Properties

data Array<AppContentListItem>	Content list items.
library string	Content library name.
subpath string	Content library relative listing path. Empty in case of root listed or representing actual subpath listed.

AppContentListItem

object

Properties

id string	Unique content identifier.
link string	Unique content link.
name string	Content name.
type string	Content type.

AppUpdateAttributes

object

Properties

name string	The name (title) of the application.
description string	The description of the application.

ChartType

string

Chart type given to current recommendation

Enum:

barchart

combochart

distributionplot

kpi

linechart

map

scatterplot

table

classification

Properties

diff number	No description
trend string	No description
absoluteDiff number	No description

Classifications

Array<string>

classification defines the default role that attribute can play in an analysis

cmpbool

Properties

baseline boolean	No description
comparison boolean	No description

cmpfloat

Properties

baseline number	No description
comparison number	No description

cmpint

Properties

baseline number	No description
comparison number	No description

comparison

object

Properties

objHeavy sortedcomparisonoobjheavy	No description
rowCount cmpint	No description
objNoCache sortedcomparisonobjresponsetime	No description
sheetCount cmpint	No description
fileSizeMib cmpfloat	No description
objectCount cmpint	No description
maxMemoryMib cmpfloat	No description
sheetsCached sortedcomparisonobjresponsetime	No description
objSlowCached sortedcomparisonobjresponsetime	No description
sheetsUncached sortedcomparisonobjresponsetime	No description
documentSizeMib cmpfloat	No description
objSlowUncached sortedcomparisonobjresponsetime	No description
dataModelSizeMib cmpfloat	No description
hasSectionAccess cmpbool	No description
topFieldsByBytes sortedcomparisonfields	No description
topTablesByBytes sortedcomparisontables	No description
objSingleThreaded sortedcomparisonobjresponsetime	No description
appOpenTimeSeconds cmpfloat	No description

comparisonfields

Array<>

comparisonobjresponsetime

Array<>

comparisonoobjheavy

Array<>

comparisontables

Array<>

CompositionMinMax

object

Upper and lower bounds for items of specific classification types

Properties

max number	No description
min number	No description

An error object.

Properties

code required string	The error code.
meta object	Additional properties relating to the error.
title required string	Summary of the problem.
detail string	A human-readable explanation specific to this occurrence of the problem.
source object	References to the source of the error.

Errors

object

Properties

errors

Array<Error>

No description

evaluation

object

Properties

id string<string>	No description
appId string<string>	No description
ended string<date-time>	No description
events Array<event>	No description
result result	No description
status string<string>	No description
appName string<string>	No description
details object	No description
sheetId string<string>	No description
started string<date-time>	No description
version number	No description
metadata metadata	No description
tenantId string<string>	No description
appItemId string<string>	No description
timestamp string<date-time>	No description
sheetTitle string<string>	No description

evaluations

object

Properties

data Array<evaluation>	No description
links object	No description

EvaluatorError

object

Properties

errors

Array<object>

No description

event

object

Properties

details string	No description
sheetId string	No description
objectId string	No description
severity string	No description
errorCode string	No description
objectType string	No description
sheetTitle string	No description
objectTitle string	No description
objectVisualization string	No description

FieldAttributes

object

Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

Formatting mechanism

The formatting mechanism depends on the type set in qType, as shown below:

<div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>

Type is DATE, TIME, TIMESTAMP or INTERVAL

The following applies:

If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
The properties qDec , qThou , qnDec , qUseThou are not used.

Type is INTEGER

The following applies:

If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

Type is REAL

The following applies:

If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is FIX

The following applies:

If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is MONEY

The following applies:

If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

Type is ASCII

No formatting, qFmt is ignored.

Properties

Dec string	Defines the decimal separator. Example: .
Fmt string	Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
Thou string	Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
Type default='UNKNOWN' string	Type of the field. Default is U. One of: U or UNKNOWN A or ASCII I or INTEGER R or REAL F or FIX M or MONEY D or DATE T or TIME TS or TIMESTAMP IV or INTERVAL Enum: UNKNOWN ASCII INTEGER REAL FIX MONEY DATE TIME TIMESTAMP INTERVAL
nDec default=10 integer<int32>	Number of decimals. Default is 10.
UseThou default=0 integer<int32>	Defines whether or not a thousands separator must be used. Default is 0.

FieldInTableProfilingData

object

Properties

Max number<double>	Maximum value of numerical values. NaN otherwise.
Min number<double>	Minimum value of numerical values. NaN otherwise.
Std number<double>	Standard deviation of numerical values. NaN otherwise.
Sum number<double>	Sum of all numerical values. NaN otherwise.
Name string	Name of the field.
Sum2 number<double>	Squared sum of all numerical values. NaN otherwise.
Median number<double>	Median of all numerical values. NaN otherwise.
Average number<double>	Average of all numerical values. NaN otherwise.
Kurtosis number<double>	Kurtosis of the numerical values. NaN otherwise.
Skewness number<double>	Skewness of the numerical values. NaN otherwise.
FieldTags Array<string>	List of tags related to the field.
Fractiles Array<number<double>>	The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.
NegValues integer<int64>	Number of negative values
PosValues integer<int64>	Number of positive values
LastSorted string	For textual values the last sorted string.
NullValues integer<int64>	Number of null values
TextValues integer<int64>	Number of textual values
ZeroValues integer<int64>	Number of zero values for numerical values
FirstSorted string	For textual values the first sorted string.
AvgStringLen number<double>	Average string length of textual values. 0 otherwise.
EmptyStrings integer<int64>	Number of empty strings
MaxStringLen integer<int64>	Maximum string length of textual values. 0 otherwise.
MinStringLen integer<int64>	Minimum string length of textual values. 0 otherwise.
MostFrequent Array<SymbolFrequency>	Three most frequent values and their frequencies
NumberFormat FieldAttributes	Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanism The formatting mechanism depends on the type set in qType, as shown below: <div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div> Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: If a format pattern is defined in qFmt , the formatting is as defined in qFmt . If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ). The properties qDec , qThou , qnDec , qUseThou are not used. Type is INTEGER The following applies: If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ). If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used . Type is REAL The following applies: If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ). If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used. If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used. If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used. Type is FIX The following applies: If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ). If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used. Type is MONEY The following applies: If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ). If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ). Type is ASCII No formatting, qFmt is ignored.
SumStringLen integer<int64>	Sum of all characters in strings in the field
NumericValues integer<int64>	Number of numeric values
DistinctValues integer<int64>	Number of distinct values
DistinctTextValues integer<int64>	Number of distinct text values
DistinctNumericValues integer<int64>	Number of distinct numeric values
FrequencyDistribution FrequencyDistributionData	No description

FieldMetadata

object

Properties

hash string	Hash of the data in the field. If the data in a reload is the same, the hash will be consistent.
name string	Name of the field.
tags Array<string>	Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.
comment string	Field comment.
cardinal integer<int32>	Number of distinct field values.
byte_size integer<int64>	Static RAM memory used in bytes.
is_hidden boolean	If set to true, the field is hidden. The default value is false.
is_locked boolean	If set to true, the field is locked. The default value is false.
is_system boolean	If set to true, the field is a system field. The default value is false.
is_numeric boolean	Is set to true if the value is a numeric. The default value is false.
src_tables Array<string>	List of table names.
is_semantic boolean	If set to true, the field is semantic. The default value is false.
total_count integer<int64>	Total number of field values.
distinct_only boolean	If set to true, only distinct field values are shown. The default value is false.
always_one_selected boolean	If set to true, the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false.

FieldOverride

object

Properties

classifications Array<string>	No description
defaultAggregation string	No description

FileData

string<binary>

FrequencyDistributionData

object

Properties

BinsEdges Array<number<double>>	Bins edges.
Frequencies Array<integer<int32>>	Bins frequencies.
NumberOfBins integer<int32>	Number of bins.

HardwareMeta

object

Properties

total_memory integer<int64>	RAM available.
logical_cores integer<int32>	Number of logical cores available.

href

string

Href

object

Properties

href

string<uri>

No description

JsonObject

object

Contains dynamic JSON data specified by the client.

LastReloadMetadata

object

Properties

hardware HardwareMeta	No description
cpu_time_spent_ms integer<int64>	Number of CPU milliseconds it took to reload the app.
peak_memory_bytes integer<int64>	Maximum number of bytes used during reload of the app.

LineageInfoRest

object

Properties

statement

string

The LOAD and SELECT script statements from the data load script.

discriminator

string

A string indicating the origin of the data:

[filename]: the data comes from a local file.
INLINE: the data is entered inline in the load script.
RESIDENT: the data comes from a resident table. The table name is listed.
AUTOGENERATE: the data is generated from the load script (no external table of data source).
Provider: the data comes from a data connection. The connector source name is listed.
[webfile]: the data comes from a web-based file.
STORE: path to QVD or TXT file where data is stored.
EXTENSION: the data comes from a Server Side Extension (SSE).

Links

object

Properties

next Href	No description
prev Href	No description
self Href	No description

Log

object

Properties

log

string

Provides a link to download the log file.

metadata

object

Properties

reloadmeta object	No description
amountofrows number	No description
amountoffields number	No description
amountoftables number	No description
staticbytesize number	No description
hassectionaccess boolean	No description
amountoffieldvalues number	No description
amountofcardinalfieldvalues number	No description

NavigationLink

object

Properties

href

string

No description

NavigationLinks

object

Properties

next NavigationLink	No description
prev NavigationLink	No description

numberFormat

object

Properties

qDec string	No description
qFmt string	No description
qThou string	No description
qType string	No description
qnDec number	No description
qUseThou number	No description

NxApp

object

Application attributes and user privileges.

Properties

create Array<NxAppCreatePrivileges>	Object create privileges. Hints to the client what type of objects the user is allowed to create.
attributes NxAttributes	App attributes. This structure can also contain extra user-defined attributes.
privileges Array<string>	Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of: read create update delete reload import publish duplicate export exportdata change_owner change_space

NxAppCreatePrivileges

object

Properties

resource string	Type of resource. For example, sheet, story, bookmark, etc.
canCreate boolean	Is set to true if the user has privileges to create the resource.

NxAppObject

object

Application object attributes and user privileges.

Properties

attributes NxObjectAttributes	App object attributes. This structure can also contain extra user-defined attributes.
privileges Array<string>	Application object privileges. Hints to the client what actions the user is allowed to perform. Could be any of: read create update delete publish exportdata change_owner

NxAttributes

object

App attributes. This structure can also contain extra user-defined attributes.

Properties

id string	The App ID.
name string	App name.
owner deprecated PII data string	Deprecated. Use user api to fetch user metadata.
usage string	One of: ANALYTICS DATA_PREPARATION Enum: ANALYTICS DATA_PREPARATION
custom JsonObject	Contains dynamic JSON data specified by the client.
ownerId string	Identifier of the app owner.
encrypted boolean	If set to true, the app is encrypted.
published boolean	True if the app is published on-prem, distributed in QCS, false if not.
thumbnail string	App thumbnail.
createdDate string<date-time>	The date and time when the app was created.
description string	App description.
originAppId string	The Origin App ID for published apps.
publishTime string<date-time>	The date and time when the app was published, empty if unpublished.
dynamicColor string	The dynamic color of the app.
modifiedDate string<date-time>	The date and time when the app was modified.
lastReloadTime string<date-time>	Date and time of the last reload of the app.
hasSectionAccess boolean	If set to true, the app has section access configured,
isDirectQueryMode boolean	True if the app is a Direct Query app, false if not

NxObjectAttributes

object

App object attributes. This structure can also contain extra user-defined attributes.

Properties

id string	The object Id.
name string	Object name.
ownerId string	The object owner's Id.
approved boolean	True if the object is approved.
createdAt string<date-time>	The date and time when the object was created.
updatedAt string<date-time>	The date and time when the object was modified.
objectType string	The type of the object.
description string	Object description.
genericType string	The generic type of the object. One of: genericObject genericBookmark genericMeasure genericDimension genericVariable Enum: genericObject genericBookmark genericMeasure genericDimension genericVariable
publishedAt string<date-time>	The date and time when the object was published, empty if unpublished.

NxPatch

object

Properties

Op string	Operation to perform. One of: add or Add remove or Remove replace or Replace Enum: Add Remove Replace
Path string	Path to the property to add, remove or replace.
Value string	This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""

objectmetrics

object

Properties

cpuSeconds Array<number>	No description
cpuQuotients Array<number>	No description
responseTimeSeconds number	No description

objectspec

object

Properties

id string<string>	No description
title string<string>	No description
sheetId string<string>	No description
objectType number	No description

objecttopspec

object

Properties

name string<string>	No description
byte_size number	No description
is_system boolean	No description

PartialNluInfo

Contains break down of the asked question in the form of tokens with their classification.

Properties

role string	Role of the token or phrase from query Enum: dimension measure date
text string	Matching token or phrase from query
type string	Type of token from query Enum: field filter master_dimension master_measure custom_analysis
fieldName string	Qlik sense application field selected for given token or phrase
fieldValue string	Filter value found from query

PublishApp

object

Properties

data string	The published app will have data from source or target app. The default is source. source: Publish with source data target: Publish with target data Enum: source target
moveApp default=false boolean	The original is moved instead of copied. The current published state of all objects is kept.
spaceId string	The managed space ID where the app will be published.
attributes AppUpdateAttributes	No description
originAppId string	If app is moved, originAppId needs to be provided.

RecommendedAnalysis

object

Properties

options object	(chart options + hypercube definition)
analysis AnalysisDetails	No description
chartType ChartType	Chart type given to current recommendation Enum: barchart combochart distributionplot kpi linechart map scatterplot table
relevance number	percentage of selected items in the analysis to the overall items passed to the endpoint
parts Array<RecommendedAnalysisCore>	part analyses (only for macro analyses)

RecommendedAnalysisCore

object

Properties

options object	(chart options + hypercube definition)
analysis AnalysisDetails	No description
chartType ChartType	Chart type given to current recommendation Enum: barchart combochart distributionplot kpi linechart map scatterplot table
relevance number	percentage of selected items in the analysis to the overall items passed to the endpoint

RecommendFieldItem

object

structure for providing fields in recommendation request, user can retrieve the fields using insight-analyses/model endpoint

Properties

name string	No description
overrides FieldOverride	No description

RecommendItems

object

Properties

fields Array<RecommendFieldItem>	No description
libItems Array<RecommendMasterItem>	No description
targetAnalysis object	No description

RecommendMasterItem

object

structure for providing master items in recommendation request, user can retrieve the libId of master item using insight-analyses/model endpoint

Properties

libId string	No description
overrides object	No description

RecommendNaturalLangQuery

object

Properties

text

required

string

The NL query.

ReloadListMetadata

object

Properties

data

Array<ReloadMeta>

Array of ReloadMeta.

ReloadMeta

object

Properties

endTime string<date-time>	Time when reload ended.
success boolean	true if the reload was successful.
duration integer<int64>	Duration of reload (ms).
reloadId string	Reload identifier.
rowLimit default=-1 integer<int64>	If greater than or equal 0, defines max number of rows loaded from a data source.
skipStore default=false boolean	Set to true to skip Store statements. The default value is false.
statements Array<ReloadStatements>	List of external loaded or stored statements.
loadFilesBytes integer<int64>	No description
isPartialReload boolean	True if the reload is a partial reload.
storeFilesBytes integer<int64>	No description
loadExternalBytes integer<int64>	No description
loadDataFilesBytes integer<int64>	No description
storeDataFilesBytes integer<int64>	No description

ReloadStatements

object

Properties

qri string	Resource Identifier.
type string	Type of statement, e.g. Store/Load.
label string	Label of the resource level node in lineage.
dataSize integer<int64>	Data loaded from the network (bytes).
duration integer<int64>	Duration of data generation (ms).
nbrOfRows integer<int64>	Number of rows loaded.
tableName string	Name of the source table in lineage.
connection string	The connecton name.
nbrOfFields integer<int64>	Number of fields loaded.
connectionId string	Connection ID.
partialReloadOperation string	Partial load operation. e.g. add/replace/update/merge. n/a when not in partial load mode.

RepublishApp

object

Properties

data string	The republished app will have data from source or target app. The default is source. source: Publish with source data target: Publish with target data Enum: source target
targetId string	The target ID to be republished.
attributes AppUpdateAttributes	No description
checkOriginAppId default=true boolean	Validate that source app is same as originally published.

result

object

Properties

sheets Array<resultobjsheet>	No description
rowCount number	No description
objNoCache Array<resultobjresponsetime>	No description
sheetCount number	No description
objectCount number	No description
objSlowCached Array<resultobjsinglethreaded>	No description
documentSizeMiB number	No description
objSlowUncached Array<resultobjresponsetime>	No description
hasSectionAccess boolean	No description
topFieldsByBytes Array<resultmetadatatopfields>	No description
topTablesByBytes Array<resultmetadatatoptables>	No description
objSingleThreaded Array<resultsingle>	No description

resultentry

Properties

id string<string>	No description
title string<string>	No description
sheetId string<string>	No description
objectType number	No description
passes Array<objectmetrics>	No description

resultmetadatatopfields

Properties

name string	No description
byte_size number	No description
is_system boolean	No description

resultmetadatatoptables

Properties

name string	No description
byte_size number	No description
is_system boolean	No description

resultobjresponsetime

Properties

id string<string>	No description
title string<string>	No description
sheetId string<string>	No description
objectType number	No description
responseTimeSeconds number	No description

resultobjsheet

object

Properties

sheet resultobjresponsetime	No description
objectCount number	No description
sheetObjects Array<resultobjresponsetime>	No description

resultobjsinglethreaded

Properties

id string<string>	No description
title string<string>	No description
sheetId string<string>	No description
objectType number	No description
schema objectspec	No description
cpuQuotients Array<number>	No description
responseTimeSeconds number	No description

resultsingle

Properties

id string<string>	No description
title string<string>	No description
sheetId string<string>	No description
objectType number	No description
cpuQuotient1 number	No description

ScriptLogList

object

Properties

data

Array<ScriptLogMeta>

Array of scriptLogMeta.

ScriptLogMeta

object

Properties

links Log	No description
endTime string<date-time>	Time when reload ended.
success boolean	True if the reload was successful.
duration integer<int64>	Duration of reload (ms).
reloadId string	Reload identifier.

ScriptMeta

object

Properties

size integer<int64>	Script size.
scriptId string	Script id.
modifierId string	User last modifying script version.
modifiedTime string	Script version last modification time.
versionMessage string	Description of this script version

ScriptMetaList

object

Properties

links NavigationLinks	No description
scripts Array<ScriptMeta>	Script versions metadata.

ScriptVersion

object

Properties

script string	Script text.
versionMessage string	Description of this script version

SimplifiedClassifications

Array<string>

sortedcomparisonfields

Properties

list Array<>	No description
absoluteDiffAsc Array<>	No description
relativeDiffAsc Array<>	No description
absoluteDiffDesc Array<>	No description
dataSourceStatus string	No description Enum: full none baselinemissing comparisonmissing
relativeDiffDesc Array<>	No description

sortedcomparisonobjresponsetime

Properties

list Array<>	No description
absoluteDiffAsc Array<>	No description
relativeDiffAsc Array<>	No description
absoluteDiffDesc Array<>	No description
dataSourceStatus string	No description Enum: full none baselinemissing comparisonmissing
relativeDiffDesc Array<>	No description

sortedcomparisonoobjheavy

Properties

list Array<>	No description
absoluteDiffAsc Array<>	No description
relativeDiffAsc Array<>	No description
absoluteDiffDesc Array<>	No description
dataSourceStatus string	No description Enum: full none baselinemissing comparisonmissing
relativeDiffDesc Array<>	No description

sortedcomparisontables

Properties

list Array<>	No description
absoluteDiffAsc Array<>	No description
relativeDiffAsc Array<>	No description
absoluteDiffDesc Array<>	No description
dataSourceStatus string	No description Enum: full none baselinemissing comparisonmissing
relativeDiffDesc Array<>	No description

SymbolFrequency

object

Properties

Symbol SymbolValue	No description
Frequency integer<int64>	Frequency of the above symbol in the field

SymbolValue

object

Properties

Text string	String value of the symbol. This parameter is optional and present only if Symbol is a string.
Number number<double>	Numeric value of the symbol. NaN otherwise.

TableMetadata

object

Properties

name string	Name of the table.
comment string	Table comment.
is_loose boolean	If set to true, the table is loose due to circular connection. The default value is false.
byte_size integer<int64>	Static RAM memory used in bytes.
is_system boolean	If set to true, the table is a system table. The default value is false.
no_of_rows integer<int64>	Number of rows.
is_semantic boolean	If set to true, the table is semantic. The default value is false.
no_of_fields integer<int32>	Number of fields.
no_of_key_fields integer<int32>	Number of key fields.

TableProfilingData

object

Properties

NoOfRows integer<int64>	Number of rows in the table.
FieldProfiling Array<FieldInTableProfilingData>	Field values profiling info

UpdateApp

object

Properties

attributes

AppUpdateAttributes

No description

UpdateSpace

object

Properties

spaceId

string

No description

v0.879.8