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}/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
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}
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.

managebuild

Creates a new app.

Request Body POST /v1/apps

optional, application/json

Attributes that the user wants to set in new app.

Responses POST /v1/apps

200
optional, application/json

OK

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","locale":"string","spaceId":"string","description":"string"}}'

Request POST /v1/apps

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

Response POST /v1/apps

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.640Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.640Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.640Z",
    "lastReloadTime": "2022-09-23T14:08:47.640Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Retrieves information for a specific app.

managebuild

Retrieves information for a specific app.

Path Parameters GET /v1/apps/{appId}

appId
string

Identifier of the app.

Responses GET /v1/apps/{appId}

200
optional, application/json

OK

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",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.640Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.640Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.640Z",
    "lastReloadTime": "2022-09-23T14:08:47.640Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Updates the information for a specific app.

managebuild

Updates the information for a specific app.

Path Parameters PUT /v1/apps/{appId}

appId
string

Identifier of the app.

Request Body PUT /v1/apps/{appId}

optional, application/json

Attributes that user wants to set.

Responses PUT /v1/apps/{appId}

200
optional, application/json

OK

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",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.641Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.641Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.641Z",
    "lastReloadTime": "2022-09-23T14:08:47.641Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Deletes a specific app.

managebuild

Deletes a specific app.

Path Parameters DELETE /v1/apps/{appId}

appId
string

Identifier of the app.

Responses DELETE /v1/apps/{appId}

200
optional
object

OK

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.

managebuild

Copies a specific app.

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

appId
string

Identifier of the app.

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

optional, application/json

Attributes that should be set in the copy.

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

200
optional, application/json

OK

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","locale":"string","spaceId":"string","description":"string"}}'

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

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

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

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.641Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.641Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.641Z",
    "lastReloadTime": "2022-09-23T14:08:47.641Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

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

managebuild

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

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

appId
string

Identifier of the app.

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

200
optional, application/json

OK

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.

managebuild

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.

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

appId
string

Identifier of the app.

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

200
optional, application/json

OK

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

{
  "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.

managebuild

Exports a specific app.

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

appId
string

Identifier of the app.

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

NoData
optional
boolean

The flag indicating if only object contents should be exported.

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

201
optional
object

Created

400
optional
object

Bad request

403
optional
object

Forbidden

404
optional
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>"

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

managebuild

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

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

appId
string

Unique application identifier.

path
string

Path to file content.

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

200
optional, application/octet-stream
string<binary>

OK

403
optional
object

Forbidden

404
optional
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.

managebuild

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.

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

appId
string

Unique application identifier.

path
string

Path to file content.

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

optional, application/octet-stream

No description

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

200
optional
object

OK

403
optional
object

Forbidden

404
optional
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.

managebuild

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.

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

appId
string

Unique application identifier.

path
string

Path to file content.

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

200
optional
object

OK

403
optional
object

Forbidden

404
optional
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.

managebuild

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.

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

appId
string

Unique application identifier.

path
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
optional
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
optional, application/json

OK

403
optional
object

Forbidden

404
optional
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.

managebuild

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.

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

appId
string

Unique application identifier.

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

200
optional, application/octet-stream
string<binary>

OK

403
optional
object

Forbidden

404
optional
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"
}

Changes owner of the app.

managebuild

Changes owner of the app.

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

appId
string

Identifier of the app.

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

optional, application/json

New owner.

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

200
optional, application/json

OK

403
optional
object

Forbidden

404
optional
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",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.641Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.641Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.641Z",
    "lastReloadTime": "2022-09-23T14:08:47.641Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Publishes a specific app to a managed space.

managebuild

Publishes a specific app to a managed space.

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

appId
string

Identifier of the app.

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

optional, application/json

Publish information for the app.

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

200
optional, application/json

OK

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","spaceId":"string","attributes":{"name":"string","description":"string"}}'

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

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

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

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.641Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.641Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.641Z",
    "lastReloadTime": "2022-09-23T14:08:47.641Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Republishes a published app to a managed space.

managebuild

Republishes a published app to a managed space.

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

appId
string

Identifier of the app.

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

optional, application/json

Republish information for the app.

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

200
optional, application/json

OK

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",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.641Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.641Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.641Z",
    "lastReloadTime": "2022-09-23T14:08:47.641Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

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

managebuild
experimental

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

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

appId
string

Identifier of the app.

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

200
optional, application/json

OK

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": "2022-09-23T14:08:47.641Z",
      "success": true,
      "duration": 0,
      "reloadId": "string"
    }
  ]
}

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

managebuild
experimental

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

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

appId
string

Identifier of the app.

reloadId
string

Identifier of the reload.

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

200
optional, application/octet-stream
string<binary>

OK

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"
}

Sets space on a specific app.

managebuild

Sets space on a specific app.

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

appId
string

Identifier of the app.

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

optional, application/json

New space.

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

200
optional, application/json

OK

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",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.642Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.642Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.642Z",
    "lastReloadTime": "2022-09-23T14:08:47.642Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Removes space from a specific app.

managebuild

Removes space from a specific app.

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

appId
string

Identifier of the app.

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

200
optional, application/json

OK

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",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.642Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.642Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.642Z",
    "lastReloadTime": "2022-09-23T14:08:47.642Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": []
}

Retrieve a list of all historic evaluations for an app GUID

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

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

guid
string

The app guid.

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

all
optional
boolean

Get the full data of the evaluation

fileMode
optional
boolean

Add file transfer headers to response

format
optional
string

Specify output format, currently supported are 'json' and 'xml'

limit
optional, default=20, minimum=1, maximum=100
integer<int32>

Number of results to return per page.

next
optional
string

The app evaluation id to get next page from

prev
optional
string

The app evaluation id to get previous page from

sort
optional
string

Property to sort list on

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

200
optional, application/json

Evaluation(s) retrieved successfully.

400
optional, application/json

Bad request.

404
optional, application/json

Not Found.

500
optional, application/json

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

Queue an app evaluation by its app guid.

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

guid
string

Guid of the app.

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

201
optional, application/json

App evaluation queued.

400
optional, application/json

Bad request, incorrect body.

403
optional, application/json

User lacks permissions to evaluate app.

404
optional, application/json

App does not exist.

500
optional, application/json

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

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

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

baseid
string

Id of the baseline evaluation

comparisonid
string

Id of the comparison evaluation

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

all
optional
boolean

Get the full list of comparisons including non-significant diffs

format
optional
string

Specify output format, currently supported are 'json' and 'xml'

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

200
optional, application/json

Comparison executed successfully.

404
optional, application/json

Not Found.

500
optional, application/json

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

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

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

baseid
string

Id of the baseline evaluation

comparisonid
string

Id of the comparison evaluation

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

200
optional, application/xml

Comparison executed successfully.

404
optional, application/json

Not Found.

500
optional, application/json

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

Find an evaluation by a specific id.

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

id
string

Id of the desired evaluation.

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

all
optional
boolean

Get the full data of the evaluation

format
optional
string

Specify output format, currently supported are 'json' and 'xml'

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

200
optional, application/json

Evaluation(s) retrieved successfully.

404
optional, application/json

Not Found.

500
optional, application/json

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

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

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

id
string

Id of the desired evaluation.

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

200
optional, application/xml

Evaluation(s) retrieved successfully.

404
optional, application/json

Not Found.

500
optional, application/json

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.

managebuild

Imports an app into the system.

Query Parameters POST /v1/apps/import

appId
optional
string

The app ID of the target app when source is qvw file.

fallbackName
optional
string

The name of the target app when source does not have a specified name, applicable if source is qvw file.

fileId
optional
string

The file ID to be downloaded from Temporary Content Service (TCS) and used during import.

mode
optional

The import mode. In new mode (default), the source app will be imported as a new app. In autoreplace mode, the app-id is extracted from the source app and used as the target app-id. If the app exists, it will be replaced. Approved objects in the target app that are not available in the source app will be removed. Non-approved objects in the target app will not be removed.

One of:

  • NEW
  • AUTOREPLACE

Enum:

NEW

AUTOREPLACE

name
optional
string

The name of the target app.

NoData
optional
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
optional
string

The space ID of the target app.

Request Body POST /v1/apps/import

optional, application/octet-stream

Path of the source app.

Responses POST /v1/apps/import

200
optional, application/json

OK

404
optional
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",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2022-09-23T14:08:47.647Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2022-09-23T14:08:47.647Z",
    "dynamicColor": "string",
    "modifiedDate": "2022-09-23T14:08:47.647Z",
    "lastReloadTime": "2022-09-23T14:08:47.647Z",
    "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.

managebuild

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.

Responses GET /v1/apps/privileges

200
optional, application/json
Array<string>

OK

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"
}

AppAttributes

object

Properties

name
optional
string

The name (title) of the application

locale
optional
string

Set custom locale instead of the system default

spaceId
optional
string

The space ID of the application

description
optional
string

The description of the application

AppContentList

object

Properties

data
optional

Content list items.

library
optional
string

Content library name.

subpath
optional
string

Content library relative listing path. Empty in case of root listed or representing actual subpath listed.

AppContentListItem

object

Properties

id
optional
string

Unique content identifier.

link
optional
string

Unique content link.

name
optional
string

Content name.

type
optional
string

Content type.

AppUpdateAttributes

object

Properties

name
optional
string

The name (title) of the application.

description
optional
string

The description of the application.

classification

Properties

diff
optional
number

No description

trend
optional
string

No description

absoluteDiff
optional
number

No description

cmpbool

Properties

baseline
optional
boolean

No description

comparison
optional
boolean

No description

cmpfloat

Properties

baseline
optional
number

No description

comparison
optional
number

No description

cmpint

Properties

baseline
optional
number

No description

comparison
optional
number

No description

comparison

object

Properties

objHeavy

No description

rowCount
optional

No description

objNoCache

No description

sheetCount
optional

No description

fileSizeMib
optional

No description

objectCount
optional

No description

maxMemoryMib
optional

No description

sheetsCached

No description

objSlowCached

No description

sheetsUncached

No description

documentSizeMib
optional

No description

objSlowUncached

No description

dataModelSizeMib
optional

No description

hasSectionAccess
optional

No description

topFieldsByBytes

No description

topTablesByBytes

No description

objSingleThreaded

No description

appOpenTimeSeconds
optional

No description

comparisonfields

Array<>

comparisonobjresponsetime

Array<>

comparisonoobjheavy

Array<>

comparisontables

Array<>

CreateApp

object

Properties

attributes

No description

DataModelMetadata

object

Properties

fields
optional

List of field descriptions.

tables
optional

List of table descriptions.

reload_meta

No description

static_byte_size
optional
integer<int64>

Static memory usage for the app.

has_section_access
optional
boolean

If set to true, the app has section access configured.

is_direct_query_mode
optional
boolean

No description

tables_profiling_data
optional

Profiling data of the tables in the app.

Error

object

Properties

errors
optional

No description

evaluation

object

Properties

id
optional
string<string>

No description

appId
optional
string<string>

No description

ended
optional
string<date-time>

No description

events
optional

No description

result
optional

No description

status
optional
string<string>

No description

appName
optional
string<string>

No description

details
optional

No description

sheetId
optional
string<string>

No description

started
optional
string<date-time>

No description

version
optional
number

No description

metadata
optional

No description

tenantId
optional
string<string>

No description

appItemId
optional
string<string>

No description

timestamp
optional
string<date-time>

No description

sheetTitle
optional
string<string>

No description

evaluations

object

Properties

data
optional

No description

links
optional

No description

event

object

Properties

details
optional
string

No description

sheetId
optional
string

No description

objectId
optional
string

No description

severity
optional
string

No description

errorCode
optional
string

No description

objectType
optional
string

No description

sheetTitle
optional
string

No description

objectTitle
optional
string

No description

objectVisualization
optional
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
optional
string

Defines the decimal separator. Example: .

Fmt
optional
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
optional
string

Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,

Type
optional, 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
optional, default=10
integer<int32>

Number of decimals. Default is 10.

UseThou
optional, default=0
integer<int32>

Defines whether or not a thousands separator must be used. Default is 0.

FieldInTableProfilingData

object

Properties

Max
optional
number<double>

Maximum value of numerical values. NaN otherwise.

Min
optional
number<double>

Minimum value of numerical values. NaN otherwise.

Std
optional
number<double>

Standard deviation of numerical values. NaN otherwise.

Sum
optional
number<double>

Sum of all numerical values. NaN otherwise.

Name
optional
string

Name of the field.

Sum2
optional
number<double>

Squared sum of all numerical values. NaN otherwise.

Median
optional
number<double>

Median of all numerical values. NaN otherwise.

Average
optional
number<double>

Average of all numerical values. NaN otherwise.

Kurtosis
optional
number<double>

Kurtosis of the numerical values. NaN otherwise.

Skewness
optional
number<double>

Skewness of the numerical values. NaN otherwise.

FieldTags
optional
Array<string>

List of tags related to the field.

Fractiles
optional
Array<number<double>>

The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

NegValues
optional
integer<int64>

Number of negative values

PosValues
optional
integer<int64>

Number of positive values

LastSorted
optional
string

For textual values the last sorted string.

NullValues
optional
integer<int64>

Number of null values

TextValues
optional
integer<int64>

Number of textual values

ZeroValues
optional
integer<int64>

Number of zero values for numerical values

FirstSorted
optional
string

For textual values the first sorted string.

AvgStringLen
optional
number<double>

Average string length of textual values. 0 otherwise.

EmptyStrings
optional
integer<int64>

Number of empty strings

MaxStringLen
optional
integer<int64>

Maximum string length of textual values. 0 otherwise.

MinStringLen
optional
integer<int64>

Minimum string length of textual values. 0 otherwise.

MostFrequent
optional

Three most frequent values and their frequencies

NumberFormat

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
optional
integer<int64>

Sum of all characters in strings in the field

NumericValues
optional
integer<int64>

Number of numeric values

DistinctValues
optional
integer<int64>

Number of distinct values

DistinctTextValues
optional
integer<int64>

Number of distinct text values

DistinctNumericValues
optional
integer<int64>

Number of distinct numeric values

FrequencyDistribution

No description

FieldMetadata

object

Properties

hash
optional
string

Hash of the data in the field. If the data in a reload is the same, the hash will be consistent.

name
optional
string

Name of the field.

tags
optional
Array<string>

Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.

comment
optional
string

Field comment.

cardinal
optional
integer<int32>

Number of distinct field values.

byte_size
optional
integer<int64>

Static RAM memory used in bytes.

is_hidden
optional
boolean

If set to true, the field is hidden. The default value is false.

is_locked
optional
boolean

If set to true, the field is locked. The default value is false.

is_system
optional
boolean

If set to true, the field is a system field. The default value is false.

is_numeric
optional
boolean

Is set to true if the value is a numeric. The default value is false.

src_tables
optional
Array<string>

List of table names.

is_semantic
optional
boolean

If set to true, the field is semantic. The default value is false.

total_count
optional
integer<int64>

Total number of field values.

distinct_only
optional
boolean

If set to true, only distinct field values are shown. The default value is false.

always_one_selected
optional
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.

FileData

string<binary>

FrequencyDistributionData

object

Properties

BinsEdges
optional
Array<number<double>>

Bins edges.

Frequencies
optional
Array<integer<int32>>

Bins frequencies.

NumberOfBins
optional
integer<int32>

Number of bins.

HardwareMeta

object

Properties

total_memory
optional
integer<int64>

RAM available.

logical_cores
optional
integer<int32>

Number of logical cores available.

href

string

JsonObject

object

Contains dynamic JSON data specified by the client.

LastReloadMetadata

object

Properties

hardware
optional

No description

cpu_time_spent_ms
optional
integer<int64>

Number of CPU milliseconds it took to reload the app.

peak_memory_bytes
optional
integer<int64>

Maximum number of bytes used during reload of the app.

LineageInfoRest

object

Properties

statement
optional
string

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

discriminator
optional
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).

Log

object
experimental

Properties

log
optional
string

Provides a link to download the log file.

metadata

object

Properties

reloadmeta
optional

No description

amountofrows
optional
number

No description

amountoffields
optional
number

No description

amountoftables
optional
number

No description

staticbytesize
optional
number

No description

hassectionaccess
optional
boolean

No description

amountoffieldvalues
optional
number

No description

amountofcardinalfieldvalues
optional
number

No description

NxApp

object

Application attributes and user privileges.

Properties

create
optional

Object create privileges. Hints to the client what type of objects the user is allowed to create.

attributes
optional

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

privileges
optional
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
optional
string

Type of resource. For example, sheet, story, bookmark, etc.

canCreate
optional
boolean

Is set to true if the user has privileges to create the resource.

NxAttributes

object

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

Properties

id
optional
string

The App ID.

name
optional
string

App name.

owner
optional
string

The owner of the app.

custom
optional

Contains dynamic JSON data specified by the client.

ownerId
optional
string

No description

encrypted
optional
boolean

If set to true, the app is encrypted.

published
optional
boolean

True if the app is published on-prem, distributed in QCS, false if not.

thumbnail
optional
string

App thumbnail.

createdDate
optional
string<date-time>

The date and time when the app was created.

description
optional
string

App description.

originAppId
optional
string

The Origin App ID for published apps.

publishTime
optional
string<date-time>

The date and time when the app was published, empty if unpublished.

dynamicColor
optional
string

The dynamic color of the app.

modifiedDate
optional
string<date-time>

The date and time when the app was modified.

lastReloadTime
optional
string<date-time>

Date and time of the last reload of the app.

hasSectionAccess
optional
boolean

If set to true, the app has section access configured,

isDirectQueryMode
optional
boolean

True if the app is a Direct Query app, false if not

objectmetrics

object

Properties

cpuSeconds
optional
Array<number>

No description

cpuQuotients
optional
Array<number>

No description

responseTimeSeconds
optional
number

No description

objectspec

object

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

objecttopspec

object

Properties

name
optional
string<string>

No description

byte_size
optional
number

No description

is_system
optional
boolean

No description

PublishApp

object

Properties

data
optional
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

spaceId
optional
string

The managed space ID where the app will be published.

attributes

No description

RepublishApp

object

Properties

data
optional
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
optional
string

The target ID to be republished.

attributes

No description

checkOriginAppId
optional, default=true
boolean

Validate that source app is same as originally published.

result

object

Properties

sheets
optional

No description

rowCount
optional
number

No description

objNoCache
optional

No description

sheetCount
optional
number

No description

objectCount
optional
number

No description

objSlowCached

No description

documentSizeMiB
optional
number

No description

objSlowUncached
optional

No description

hasSectionAccess
optional
boolean

No description

topFieldsByBytes

No description

topTablesByBytes

No description

objSingleThreaded
optional

No description

resultentry

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

passes
optional

No description

resultmetadatatopfields

Properties

name
optional
string

No description

byte_size
optional
number

No description

is_system
optional
boolean

No description

resultmetadatatoptables

Properties

name
optional
string

No description

byte_size
optional
number

No description

is_system
optional
boolean

No description

resultobjresponsetime

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

responseTimeSeconds
optional
number

No description

resultobjsheet

object

Properties

sheet

No description

objectCount
optional
number

No description

sheetObjects
optional

No description

resultobjsinglethreaded

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

schema
optional

No description

cpuQuotients
optional
Array<number>

No description

responseTimeSeconds
optional
number

No description

resultsingle

Properties

id
optional
string<string>

No description

title
optional
string<string>

No description

sheetId
optional
string<string>

No description

objectType
optional
number

No description

cpuQuotient1
optional
number

No description

ScriptLogList

object
experimental

Properties

data
optional

Array of scriptLogMeta.

ScriptLogMeta

object
experimental

Properties

links
optional

No description

endTime
optional
string<date-time>

Time when reload ended.

success
optional
boolean

True if the reload was successful.

duration
optional
integer<int64>

Duration of reload (ms).

reloadId
optional
string

Reload identifier.

sortedcomparisonfields

Properties

list
optional

No description

absoluteDiffAsc
optional

No description

relativeDiffAsc
optional

No description

absoluteDiffDesc
optional

No description

dataSourceStatus
optional
string

No description

Enum:

full

none

baselinemissing

comparisonmissing

relativeDiffDesc
optional

No description

sortedcomparisonobjresponsetime

Properties

list
optional

No description

absoluteDiffAsc
optional

No description

relativeDiffAsc
optional

No description

absoluteDiffDesc
optional

No description

dataSourceStatus
optional
string

No description

Enum:

full

none

baselinemissing

comparisonmissing

relativeDiffDesc
optional

No description

sortedcomparisonoobjheavy

Properties

list
optional

No description

absoluteDiffAsc
optional

No description

relativeDiffAsc
optional

No description

absoluteDiffDesc
optional

No description

dataSourceStatus
optional
string

No description

Enum:

full

none

baselinemissing

comparisonmissing

relativeDiffDesc
optional

No description

sortedcomparisontables

Properties

list
optional

No description

absoluteDiffAsc
optional

No description

relativeDiffAsc
optional

No description

absoluteDiffDesc
optional

No description

dataSourceStatus
optional
string

No description

Enum:

full

none

baselinemissing

comparisonmissing

relativeDiffDesc
optional

No description

SymbolFrequency

object

Properties

Symbol
optional

No description

Frequency
optional
integer<int64>

Frequency of the above symbol in the field

SymbolValue

object

Properties

Text
optional
string

String value of the symbol. This parameter is optional and present only if Symbol is a string.

Number
optional
number<double>

Numeric value of the symbol. NaN otherwise.

TableMetadata

object

Properties

name
optional
string

Name of the table.

comment
optional
string

Table comment.

is_loose
optional
boolean

If set to true, the table is loose due to circular connection. The default value is false.

byte_size
optional
integer<int64>

Static RAM memory used in bytes.

is_system
optional
boolean

If set to true, the table is a system table. The default value is false.

no_of_rows
optional
integer<int64>

Number of rows.

is_semantic
optional
boolean

If set to true, the table is semantic. The default value is false.

no_of_fields
optional
integer<int32>

Number of fields.

no_of_key_fields
optional
integer<int32>

Number of key fields.

TableProfilingData

object

Properties

NoOfRows
optional
integer<int64>

Number of rows in the table.

FieldProfiling

Field values profiling info

UpdateApp

object

Properties

attributes

No description

UpdateOwner

object

Properties

ownerId
optional
string

No description

UpdateSpace

object

Properties

spaceId
optional
string

No description

v0.448.13
Was this page helpful?