Apps

Download OpenAPI spec

Create, manage, and retrieve analytics applications in Qlik Cloud.

New capabilities in the analytics namespace

Some new capabilities are only being added to the Apps API in the analytics namespace.

Where endpoints are available in the analytics namespace, use those instead.

This API remains available and fully supported.

Endpoints

POST

/api/v1/apps
GET

/api/v1/apps/{appId}
PUT

/api/v1/apps/{appId}
DELETE

/api/v1/apps/{appId}
POST

/api/v1/apps/{appId}/copy
GET

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

/api/v1/apps/{appId}/data/metadata
POST

/api/v1/apps/{appId}/export
GET

/api/v1/apps/{appId}/insight-analyses
POST

/api/v1/apps/{appId}/insight-analyses/actions/recommend
GET

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

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

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

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

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

/api/v1/apps/{appId}/media/thumbnail
POST

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

/api/v1/apps/{appId}/owner
GET

/api/v1/apps/{appId}/placement
PUT

/api/v1/apps/{appId}/placement
DELETE

/api/v1/apps/{appId}/placement
POST

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

/api/v1/apps/{appId}/publish
GET

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

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

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

/api/v1/apps/{appId}/report-filters
POST

/api/v1/apps/{appId}/report-filters
GET

/api/v1/apps/{appId}/report-filters/{id}
PATCH

/api/v1/apps/{appId}/report-filters/{id}
DELETE

/api/v1/apps/{appId}/report-filters/{id}
GET

/api/v1/apps/{appId}/report-filters/actions/count
GET

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

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

/api/v1/apps/{appId}/scripts/{id}
PATCH

/api/v1/apps/{appId}/scripts/{id}
DELETE

/api/v1/apps/{appId}/scripts/{id}
PUT

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

/api/v1/apps/{appId}/space
GET

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

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

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

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

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

/api/v1/apps/evaluations/{id}/actions/download
POST

/api/v1/apps/import
GET

/api/v1/apps/privileges
POST

/api/v1/apps/validatescript

Creates a new app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

Attributes that the user wants to set in new app.

*/* object
Show */* properties
- attributes object
  
  Show attributes properties
  
  name string
  
  The name (title) of the application
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  locale string
  
  Set custom locale instead of the system default
  
  spaceId string
  
  The space ID of the application
  
  description string
  
  The description of the application

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

POST /api/v1/apps

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.createApp({
  attributes: {
    description: 'string',
    locale: 'string',
    name: 'string',
    spaceId: 'string',
  },
})

qlik app create

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"attributes":{"name":"string","locale":"string","spaceId":"string","description":"string"}}'

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

Retrieves information for a specific app.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

GET /api/v1/apps/{appId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppInfo('string')

qlik app get 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

Updates the information for a specific app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Request Body

Required

Attributes that user wants to set.

*/* object
Show */* properties
- attributes object
  
  Show attributes properties
  
  name string
  
  The name (title) of the application.
  
  description string
  
  The description of the application.

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

PUT /api/v1/apps/{appId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.updateAppInfo('string', {
  attributes: {
    description: 'string',
    name: 'string',
  },
})

qlik app update 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"attributes":{"name":"string","description":"string"}}'

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

Deletes a specific app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Responses

200

OK

DELETE /api/v1/apps/{appId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.deleteApp('string')

qlik app rm 'string'

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

Copies a specific app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Request Body

Required

Attributes that should be set in the copy.

*/* object
Show */* properties
- attributes object
  
  Show attributes properties
  
  name string
  
  The name (title) of the application
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  locale string
  
  Set custom locale instead of the system default
  
  spaceId string
  
  The space ID of the application
  
  description string
  
  The description of the application

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.copyApp('string', {
  attributes: {
    description: 'string',
    locale: 'string',
    name: 'string',
    spaceId: 'string',
  },
})

qlik app copy 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/copy" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"attributes":{"name":"string","locale":"string","spaceId":"string","description":"string"}}'

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

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

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Responses

200

OK

application/json array of objects
Show application/json properties
- statement string
  
  The LOAD and SELECT script statements from the data load script.
- discriminator string
  
  A string indicating the origin of the data:
  
  [filename]: the data comes from a local file.
  
  INLINE: the data is entered inline in the load script.
  
  RESIDENT: the data comes from a resident table. The table name is listed.
  
  AUTOGENERATE: the data is generated from the load script (no external table of data source).
  
  Provider: the data comes from a data connection. The connector source name is listed.
  
  [webfile]: the data comes from a web-based file.
  
  STORE: path to QVD or TXT file where data is stored.
  
  EXTENSION: the data comes from a Server Side Extension (SSE).

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppDataLineage('string')

qlik app data lineage \
  --appId 'string'

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

Example Response

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

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Responses

200

OK

application/json object
Show application/json properties
- usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- fields array of objects
  
  List of field descriptions.
  
  Show fields properties
  
  hash string
  
  Hash of the data in the field. If the data in a reload is the same, the hash will be consistent.
  
  name string
  
  Name of the field.
  
  tags array of strings
  
  Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.
  
  comment string
  
  Field comment.
  
  cardinal integer
  
  Number of distinct field values.
  
  format = int32
  
  byte_size integer
  
  Static RAM memory used in bytes.
  
  format = int64
  
  is_hidden boolean
  
  If set to true, the field is hidden. The default value is false.
  
  is_locked boolean
  
  If set to true, the field is locked. The default value is false.
  
  is_system boolean
  
  If set to true, the field is a system field. The default value is false.
  
  is_numeric boolean
  
  Is set to true if the value is a numeric. The default value is false.
  
  src_tables array of strings
  
  List of table names.
  
  is_semantic boolean
  
  If set to true, the field is semantic. The default value is false.
  
  total_count integer
  
  Total number of field values.
  
  format = int64
  
  distinct_only boolean
  
  If set to true, only distinct field values are shown. The default value is false.
  
  always_one_selected boolean
  
  If set to true, the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false.
- tables array of objects
  
  List of table descriptions.
  
  Show tables properties
  
  name string
  
  Name of the table.
  
  comment string
  
  Table comment.
  
  is_loose boolean
  
  If set to true, the table is loose due to circular connection. The default value is false.
  
  byte_size integer
  
  Static RAM memory used in bytes.
  
  format = int64
  
  is_system boolean
  
  If set to true, the table is a system table. The default value is false.
  
  no_of_rows integer
  
  Number of rows.
  
  format = int64
  
  is_semantic boolean
  
  If set to true, the table is semantic. The default value is false.
  
  no_of_fields integer
  
  Number of fields.
  
  format = int32
  
  no_of_key_fields integer
  
  Number of key fields.
  
  format = int32
- reload_meta object
  
  Show reload_meta properties
  
  hardware object
  
  Show hardware properties
  
  total_memory integer
  
  RAM available.
  
  format = int64
  
  logical_cores integer
  
  Number of logical cores available.
  
  format = int32
  
  cpu_time_spent_ms integer
  
  Number of CPU milliseconds it took to reload the app.
  
  format = int64
  
  peak_memory_bytes integer
  
  Maximum number of bytes used during reload of the app.
  
  format = int64
  
  fullReloadPeakMemoryBytes integer
  
  Maximum number of bytes used during full reload of the app.
  
  format = int64
  
  partialReloadPeakMemoryBytes integer
  
  Maximum number of bytes used during partial reload of the app.
  
  format = int64
- static_byte_size integer
  
  Static memory usage for the app.
  
  format = int64
- has_section_access boolean
  
  If set to true, the app has section access configured.
- is_direct_query_mode boolean
- tables_profiling_data array of objects
  
  Profiling data of the tables in the app.
  
  Show tables_profiling_data properties
  
  NoOfRows integer
  
  Number of rows in the table.
  
  format = int64
  
  FieldProfiling array of objects
  
  Field values profiling info
  
  Show FieldProfiling properties
  
  Max number
  
  Maximum value of numerical values. NaN otherwise.
  
  format = double
  
  Min number
  
  Minimum value of numerical values. NaN otherwise.
  
  format = double
  
  Std number
  
  Standard deviation of numerical values. NaN otherwise.
  
  format = double
  
  Sum number
  
  Sum of all numerical values. NaN otherwise.
  
  format = double
  
  Name string
  
  Name of the field.
  
  Sum2 number
  
  Squared sum of all numerical values. NaN otherwise.
  
  format = double
  
  Median number
  
  Median of all numerical values. NaN otherwise.
  
  format = double
  
  Average number
  
  Average of all numerical values. NaN otherwise.
  
  format = double
  
  Kurtosis number
  
  Kurtosis of the numerical values. NaN otherwise.
  
  format = double
  
  Skewness number
  
  Skewness of the numerical values. NaN otherwise.
  
  format = double
  
  FieldTags array of strings
  
  List of tags related to the field.
  
  Fractiles array of numbers
  
  The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.
  
  NegValues integer
  
  Number of negative values
  
  format = int64
  
  PosValues integer
  
  Number of positive values
  
  format = int64
  
  LastSorted string
  
  For textual values the last sorted string.
  
  NullValues integer
  
  Number of null values
  
  format = int64
  
  TextValues integer
  
  Number of textual values
  
  format = int64
  
  ZeroValues integer
  
  Number of zero values for numerical values
  
  format = int64
  
  FirstSorted string
  
  For textual values the first sorted string.
  
  AvgStringLen number
  
  Average string length of textual values. 0 otherwise.
  
  format = double
  
  DataEvenness number
  
  Data evenness aka Shannon's entropy normalized to [0,1]
  
  format = double
  
  EmptyStrings integer
  
  Number of empty strings
  
  format = int64
  
  MaxStringLen integer
  
  Maximum string length of textual values. 0 otherwise.
  
  format = int64
  
  MinStringLen integer
  
  Minimum string length of textual values. 0 otherwise.
  
  format = int64
  
  MostFrequent array of objects
  
  Three most frequent values and their frequencies
  
  Show MostFrequent properties
  
  Symbol object
  
  Show Symbol properties
  
  Text string
  
  String value of the symbol. This parameter is optional and present only if Symbol is a string.
  
  Number number
  
  Numeric value of the symbol. NaN otherwise.
  
  format = double
  
  Frequency integer
  
  Frequency of the above symbol in the field
  
  format = int64
  
  NumberFormat 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:
  
  In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
  
  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.
  
  Show NumberFormat properties
  
  Dec string
  
  Defines the decimal separator. Example: .
  
  Fmt string
  
  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
  
  Thou string
  
  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  
  Type string
  
  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
  
  nDec integer
  
  Number of decimals. Default is 10.
  
  default = 10, format = int32, default = 10
  
  UseThou integer
  
  Defines whether or not a thousands separator must be used. Default is 0.
  
  default = 0, format = int32, default = 0
  
  SumStringLen integer
  
  Sum of all characters in strings in the field
  
  format = int64
  
  NumericValues integer
  
  Number of numeric values
  
  format = int64
  
  DistinctValues integer
  
  Number of distinct values
  
  format = int64
  
  DistinctTextValues integer
  
  Number of distinct text values
  
  format = int64
  
  DistinctNumericValues integer
  
  Number of distinct numeric values
  
  format = int64
  
  FrequencyDistribution object
  
  Show FrequencyDistribution properties
  
  BinsEdges array of numbers
  
  Bins edges.
  
  Frequencies array of integers
  
  Bins frequencies.
  
  NumberOfBins integer
  
  Number of bins.
  
  format = int32

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppDataMetadata('string')

qlik app data metadata \
  --appId 'string'

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

Example Response

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

Exports a specific app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Query Parameters

NoData boolean

The flag indicating if only object contents should be exported.

Path Parameters

appId string

Required

Identifier of the app.

Responses

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.exportApp('string', {})

qlik app export 'string'

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

Facts

Rate limit

Special (500 requests per minute)

Header Parameters

accept-language string

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

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"

Responses

200

The request is successfully processed and information about supported analyses is returned.

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  compositions array of objects
  
  Show compositions properties
  
  dims object
  
  Upper and lower bounds for items of specific classification types
  
  Show dims properties
  
  max number
  
  min number
  
  geos object
  
  Upper and lower bounds for items of specific classification types
  
  Show geos properties
  
  max number
  
  min number
  
  msrs object
  
  Upper and lower bounds for items of specific classification types
  
  Show msrs properties
  
  max number
  
  min number
  
  items object
  
  Upper and lower bounds for items of specific classification types
  
  Show items properties
  
  max number
  
  min number
  
  temporals object
  
  Upper and lower bounds for items of specific classification types
  
  Show temporals properties
  
  max number
  
  min number
  
  description object
  
  Show description properties
  
  long string
  
  short string
  
  supportsMasterItems boolean
  
  If analysis can work with master items (default is true)
  
  requiresAutoCalendarPeriod boolean
  
  Used for period-specific analyses to indicate the defined or available calendar period must be of type autoCalendar
  
  requiresDefinedAnalysisPeriod boolean
  
  Used for period-specific analyses to indicate the measure must be associated with one or more analysis periods
  
  requiresAvailableAnalysisPeriod boolean
  
  Used for period-specific analyses to indicate the temporal dimension must be associated with one or more analysis periods
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"

400

Bad request. The payload is not formed correctly.

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

401

User is not authorized

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

422

Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

500

Internal server error

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppInsightAnalyses(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

qlik app insight-analysis ls 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

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

Example Response

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

Facts

Rate limit

Special (500 requests per minute)

Header Parameters

accept-language string

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

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"

Request Body

Required

application/json object
Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis. In below examples, consider sales as a master item and product as field, so to get recommendations using sales and product, you can utilize below three approaches, also you can set language parameter in headers as part of accept-language. Examples:
```
{
  'text': 'show me sales by product'
}
```
```
{
  'fields': [
    {
      'name': 'product'
    }
  ],
  'libItems': [
    {
      libId: 'NwQfJ'
    }
  ]
}
```
```
{
  'fields': [
    {
      'name': 'product'
    }
  ],
  'libItems': [
    {
      'libId': 'NwQfJ'
    }
  ],
  'targetAnalysis': {
    'id': 'rank-rank'
  }
}
```
One of:
- RecommendNaturalLangQuery object
  Show RecommendNaturalLangQuery properties
  
  text string
  
  Required
  
  The NL query.
- RecommendItems object
  Show RecommendItems properties
  
  fields array of objects
  
  structure for providing fields in recommendation request, user can retrieve the fields using insight-analyses/model endpoint
  
  Show fields properties
  
  name string
  
  overrides object
  
  Show overrides properties
  
  classifications array of strings
  
  defaultAggregation string
  
  libItems array of objects
  
  structure for providing master items in recommendation request, user can retrieve the libId of master item using insight-analyses/model endpoint
  
  Show libItems properties
  
  libId string
  
  overrides object
  
  Show overrides properties
  
  format object
  
  Show format properties
  
  qDec string
  
  qFmt string
  
  qThou string
  
  qType string
  
  qnDec number
  
  qUseThou number
  
  targetAnalysis object
  
  Show targetAnalysis properties
  
  id string
  
  id of the target analysis, returned by the GET insight-analyses endpoint

Responses

200

The request is successfully processed and recommendations are returned.

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  nluInfo array of objects
  
  Contains break down of the asked question in the form of tokens with their classification.
  
  Show nluInfo properties
  
  role string
  
  Role of the token or phrase from query
  
  Can be one of: "dimension""measure""date"
  
  text string
  
  Matching token or phrase from query
  
  type string
  
  Type of token from query
  
  Can be one of: "field""filter""master_dimension""master_measure""custom_analysis"
  
  fieldName string
  
  Qlik sense application field selected for given token or phrase
  
  fieldValue string
  
  Filter value found from query
  
  recAnalyses array of objects
  
  Required
  
  Show recAnalyses properties
  
  options object
  
  (chart options + hypercube definition)
  
  analysis object
  
  Show analysis properties
  
  title string
  
  analysis string
  
  Can be one of: "breakdown""changePoint""comparison""contribution""correlation""fact""mutualInfo""rank""spike""trend""values"
  
  analysisGroup string
  
  Can be one of: "anomaly""brekadown""comparison""correl""fact""list""mutualInfo""rank"
  
  chartType string
  
  Chart type given to current recommendation
  
  Can be one of: "barchart""combochart""distributionplot""kpi""linechart""map""scatterplot""table"
  
  relevance number
  
  percentage of selected items in the analysis to the overall items passed to the endpoint
  
  parts array of objects
  
  part analyses (only for macro analyses)
  
  Show parts properties
  
  options object
  
  (chart options + hypercube definition)
  
  analysis object
  
  Show analysis properties
  
  title string
  
  analysis string
  
  Can be one of: "breakdown""changePoint""comparison""contribution""correlation""fact""mutualInfo""rank""spike""trend""values"
  
  analysisGroup string
  
  Can be one of: "anomaly""brekadown""comparison""correl""fact""list""mutualInfo""rank"
  
  chartType string
  
  Chart type given to current recommendation
  
  Can be one of: "barchart""combochart""distributionplot""kpi""linechart""map""scatterplot""table"
  
  relevance number
  
  percentage of selected items in the analysis to the overall items passed to the endpoint

400

Bad request. The payload is not formed correctly.

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

401

User is not authorized

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

409

Invalid Business Logic

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

422

Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

500

Internal server error

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppInsightAnalysisRecommendations(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  { text: 'string' },
)

qlik app insight-analysis recommend 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69' \
  --text 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/insight-analyses/actions/recommend" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"text":"string"}'

Example Response

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

Facts

Rate limit

Special (500 requests per minute)

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"

Responses

200

The request is successfully processed and information about model is returned.

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  fields array of objects
  
  Show fields properties
  
  name string
  
  populated only for fields
  
  isHidden boolean
  
  whether the field is hidden in business logic
  
  default = false
  
  classifications array of strings
  
  classification defines the default role that attribute can play in an analysis
  
  Values may be any of: "dimension""measure""temporal""city""address""boolean""country""date""email""geographical""geoPoint""geoPolygon""hour""latitude""monetary""ordinal""percentage""postalCode""quarter""stateProvince""timestamp""week""weekDay""year""yearDay"
  
  simplifiedClassifications array of strings
  
  Values may be any of: "dimension""measure""temporal""geographical"
  
  masterItems array of objects
  
  Show masterItems properties
  
  libId string
  
  only available for master items
  
  caption string
  
  isHidden boolean
  
  whether the master item is hidden in business logic
  
  default = false
  
  classifications array of strings
  
  classification defines the default role that attribute can play in an analysis
  
  Values may be any of: "dimension""measure""temporal""city""address""boolean""country""date""email""geographical""geoPoint""geoPolygon""hour""latitude""monetary""ordinal""percentage""postalCode""quarter""stateProvince""timestamp""week""weekDay""year""yearDay"
  
  simplifiedClassifications array of strings
  
  Values may be any of: "dimension""measure""temporal""geographical"
  
  isLogicalModelEnabled boolean
  
  if the analysis model is constructed based on a user-defined business-logic (as opposed to a default one)
  
  isDefinedLogicalModelValid boolean
  
  set only if previous property is true, to indicate if the business logic passes validation
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"

400

Bad request. The payload is not formed correctly.

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

401

User is not authorized

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

409

Invalid Business Logic

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

422

Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

500

Internal server error

application/json object
Show application/json properties
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON Pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppInsightAnalysisModel(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

qlik app insight-analysis model 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

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

Example Response

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

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

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Unique application identifier.
path string

Required

Path to file content.

Responses

200

OK

application/octet-stream string

format = "binary"

403

Forbidden

404

Not Found

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppMedia('string', 'string')

qlik app media file get 'string' \
  --appId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
-H "Authorization: Bearer <access_token>" \
-o "output-file"

Stores the media content file. Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Unique application identifier.
path string

Required

Path to file content.

Request Body

Required

application/octet-stream string

format = "binary"

Responses

200

OK

403

Forbidden

404

Not Found

409

Conflict

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

import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.uploadAppMedia(
  'string',
  'string',
  new Uint8Array(readFileSync('<file-path>')),
)

qlik app media file update 'string' \
  --appId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
-X PUT \
-H "Content-type: application/octet-stream" \
-H "Authorization: Bearer <access_token>" \
--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.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Unique application identifier.
path string

Required

Path to file content.

Responses

200

OK

403

Forbidden

404

Not Found

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.deleteAppMedia('string', 'string')

qlik app media file rm 'string' \
  --appId 'string'

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

Lists media content. Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

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

Path Parameters

appId string

Required

Unique application identifier.
path string

Required

The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Content list items.
  
  Show data properties
  
  id string
  
  Unique content identifier.
  
  link string
  
  Unique content link.
  
  name string
  
  Content name.
  
  type string
  
  Content type.
- library string
  
  Content library name.
- subpath string
  
  Content library relative listing path. Empty in case of root listed or representing actual subpath listed.

403

Forbidden

404

Not Found

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppMediaList(
  'string',
  'string',
  {},
)

qlik app media list get 'string' \
  --appId 'string'

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

Example Response

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

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Unique application identifier.

Responses

200

OK

application/octet-stream string

format = "binary"

403

Forbidden

404

Not Found

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppThumbnail('string')

qlik app media thumbnail \
  --appId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/media/thumbnail" \
-H "Authorization: Bearer <access_token>" \
-o "output-file"

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

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.
objectId string

Required

Identifier of the object.

Request Body

Required

New owner of the object.

*/* object
Show */* properties
- ownerId string

Responses

200

OK

application/json object

Attributes and user privileges for an app object.
Show application/json properties
- attributes object
  
  App object attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  Identifier of the object.
  
  name string
  
  Object name.
  
  ownerId string
  
  Identifier of the object owner.
  
  approved boolean
  
  When true, the object is approved.
  
  createdAt string
  
  The date and time when the object was created.
  
  format = "date-time"
  
  updatedAt string
  
  The date and time when the object was modified.
  
  format = "date-time"
  
  objectType string
  
  The type of the object.
  
  description string
  
  Object description.
  
  genericType string
  
  Can be one of: "genericObject""genericBookmark""genericMeasure""genericDimension""genericVariable"
  
  publishedAt string
  
  The date and time when the object was published, empty if unpublished.
  
  format = "date-time"
- privileges array of strings
  
  App object privileges. Hints to the client regarding actions the user can perform. Possible values:
  
  read
  
  create
  
  update
  
  delete
  
  publish
  
  exportdata
  
  change_owner

400

Bad request

404

Not Found

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.updateAppObjectOwner(
  'string',
  'string',
  { ownerId: 'string' },
)

qlik app object change-owner \
  --appId 'string' \
  --objectId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/objects/{objectId}/actions/change-owner" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"ownerId":"string"}'

Example Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "ownerId": "string",
    "approved": true,
    "createdAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "objectType": "string",
    "description": "string",
    "publishedAt": "2018-10-30T07:06:22Z"
  },
  "privileges": [
    "string"
  ]
}

Changes owner of the app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Request Body

Required

New owner.

*/* object
Show */* properties
- ownerId string

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

403

Forbidden

404

Not Found

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.updateAppOwner('string', {
  ownerId: 'string',
})

qlik app owner 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/owner" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"ownerId":"string"}'

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

Retrieves the app size override for an app.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Identifier of the app

Responses

200

OK

application/json object

Override for app placement on non reload engines.
Show application/json properties
- createdAt string
  
  The iso timestamp for when the override was configured.
  
  format = "date-time"
- minEngineSize string
  
  Can be one of: "0""40""60""80""120""160""200"

GET /api/v1/apps/{appId}/placement

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppPlacement('string')

qlik app placement ls 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/placement" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "createdAt": "2018-10-30T07:06:22Z"
}

Sets the app size override for an app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app

Request Body

Required

The override information to be used for app placement.

*/* object

Engine size override for app placement on non reload engines.
Show */* properties
- minEngineSize string
  
  Can be one of: "0""40""60""80""120""160""200"

Responses

200

OK

PUT /api/v1/apps/{appId}/placement

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.replaceAppPlacement('string', {})

qlik app placement update 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/placement" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{}'

Removes the app size override for an app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app

Responses

200

OK

DELETE /api/v1/apps/{appId}/placement

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.deleteAppPlacement('string')

qlik app placement delete-many 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/placement" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Publishes a specific app to a managed space.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Request Body

Required

Publish information for the app.

*/* object
Show */* properties
- data string
  
  Can be one of: "source""target"
- moveApp boolean
  
  When true, the original is moved instead of copied, keeping the current published state of all objects. The default value is false.
  
  default = false
- spaceId string
  
  The managed space ID where the app will be published.
- attributes object
  
  Show attributes properties
  
  name string
  
  The name (title) of the application.
  
  description string
  
  The description of the application.
- originAppId string
  
  Required when moving the app, specifying the identifier of the original app.

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.publishApp('string', {
  attributes: {
    description: 'string',
    name: 'string',
  },
  originAppId: 'string',
  spaceId: 'string',
})

qlik app publish create 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/publish" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"moveApp":false,"spaceId":"string","attributes":{"name":"string","description":"string"},"originAppId":"string"}'

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

Republishes a published app to a managed space.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Request Body

Required

Republish information for the app.

*/* object
Show */* properties
- data string
  
  Can be one of: "source""target"
- targetId string
  
  The target ID to be republished.
- attributes object
  
  Show attributes properties
  
  name string
  
  The name (title) of the application.
  
  description string
  
  The description of the application.
- checkOriginAppId boolean
  
  Validate that source app is same as originally published.
  
  default = true

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.republishApp('string', {
  attributes: {
    description: 'string',
    name: 'string',
  },
  checkOriginAppId: true,
  targetId: 'string',
})

qlik app publish update 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/publish" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"targetId":"string","attributes":{"name":"string","description":"string"},"checkOriginAppId":true}'

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

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

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Array of scriptLogMeta.
  
  Show data properties
  
  links object
  
  Show links properties
  
  log string
  
  Provides a link to download the log file.
  
  endTime string
  
  Time when reload ended.
  
  format = "date-time"
  
  success boolean
  
  True if the reload was successful.
  
  duration integer
  
  Duration of reload (ms).
  
  format = int64
  
  reloadId string
  
  Reload identifier.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppReloadLogs('string')

# qlik-cli has not implemented support for GET /api/v1/apps/{appId}/reloads/logs yet.

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

Example Response

{
  "data": [
    {
      "links": {
        "log": "string"
      },
      "endTime": "2018-10-30T07:06:22Z",
      "success": true,
      "duration": 42,
      "reloadId": "string"
    }
  ]
}

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

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.
reloadId string

Required

Identifier of the reload.

Responses

200

OK

text/plain string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppReloadLog(
  'string',
  'string',
)

# qlik-cli has not implemented support for GET /api/v1/apps/{appId}/reloads/logs/{reloadId} yet.

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

Example Response

string

Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info. Data is available for the last 10 reloads of an application.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

includeSkipStoreReloads boolean

Include metadata for reloads ran with SkipStore flag set to true. Default: false.
limit string

Maximum number of records to return from this request. The default value is 100.
reloadId string

Identifier of the reload. Use empty reloadId to get all reloads.

Path Parameters

appId string

Required

Identifier of the app.

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Array of ReloadMeta.
  
  Show data properties
  
  endTime string
  
  Time when reload ended.
  
  format = "date-time"
  
  success boolean
  
  true if the reload was successful.
  
  duration integer
  
  Duration of reload (ms).
  
  format = int64
  
  reloadId string
  
  Reload identifier.
  
  rowLimit integer
  
  If greater than or equal to 0, defines the maximum number of rows loaded from a data source.
  
  default = -1, format = int64, default = -1
  
  appDbHash string
  
  A Base64-encoded hash value of the new app database.
  
  skipStore boolean
  
  Set to true to skip Store statements. The default value is false.
  
  default = false
  
  storeHash string
  
  A Base64-encoded hash value of all fields stored via the store statements.
  
  statements array of objects
  
  List of external loaded or stored statements.
  
  Show statements properties
  
  qri string
  
  Resource Identifier.
  
  type string
  
  Type of statement, e.g. Store/Load.
  
  label string
  
  Label of the resource level node in lineage.
  
  dataSize integer
  
  Data loaded from the network (bytes).
  
  format = int64
  
  duration integer
  
  Duration of data generation (ms).
  
  format = int64
  
  nbrOfRows integer
  
  Number of rows loaded.
  
  format = int64
  
  tableName string
  
  Name of the source table in lineage.
  
  connection string
  
  The connection name.
  
  nbrOfFields integer
  
  Number of fields loaded.
  
  format = int64
  
  connectionId string
  
  Connection ID.
  
  partialReloadOperation string
  
  Partial load operation. e.g. add/replace/update/merge. n/a when not in partial load mode.
  
  accessDbHash string
  
  A Base64-encoded hash value of the new section access database.
  
  includeFiles array of objects
  
  Files brought into the script via include/mustInclude macros.
  
  Show includeFiles properties
  
  qri string
  
  File QRI resource identifier.
  
  path string
  
  File location within the connection.
  
  connection string
  
  The connection name.
  
  loadFilesBytes integer
  
  format = int64
  
  isPartialReload boolean
  
  True if the reload is a partial reload.
  
  storeFilesBytes integer
  
  format = int64
  
  loadExternalBytes integer
  
  format = int64
  
  loadDataFilesBytes integer
  
  format = int64
  
  storeDataFilesBytes integer
  
  format = int64

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppReloadMetadata(
  'string',
  '',
  {},
)

qlik app reload-metadata '' \
  --appId 'string'

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

Example Response

{
  "data": [
    {
      "endTime": "2018-10-30T07:06:22Z",
      "success": true,
      "duration": 42,
      "reloadId": "string",
      "rowLimit": -1,
      "appDbHash": "string",
      "skipStore": false,
      "storeHash": "string",
      "statements": [
        {
          "qri": "string",
          "type": "string",
          "label": "string",
          "dataSize": 42,
          "duration": 42,
          "nbrOfRows": 42,
          "tableName": "string",
          "connection": "string",
          "nbrOfFields": 42,
          "connectionId": "string",
          "partialReloadOperation": "string"
        }
      ],
      "accessDbHash": "string",
      "includeFiles": [
        {
          "qri": "string",
          "path": "string",
          "connection": "string"
        }
      ],
      "loadFilesBytes": 42,
      "isPartialReload": true,
      "storeFilesBytes": 42,
      "loadExternalBytes": 42,
      "loadDataFilesBytes": 42,
      "storeDataFilesBytes": 42
    }
  ]
}

List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filterTypes array of strings

Required

The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.

Values may be any of: "REP""SUB"
minItems = 1
filter string

The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive. The following fields support the co (contains) operator: name, description The following fields support the eq (equals) operator: id, ownerId Example: (name co "query1" or description co "query2") and ownerId eq "123"
limit integer

Limit the returned result set

minimum = 1, maximum = 100, default = 20, default = 20
loadType string

Load type expressing the kind of request, eg. interactive for report requests from the Web UI, batch for scheduled report generation.

Can be one of: "interactive""batch"
default = "interactive"
page string

If present, the cursor that starts the page of data that is returned.
sort array of strings

Sorting parameters.

Values may be any of: "+ownerId""-ownerId""-name""+name""+description""-description""+createdAt""-createdAt""+updatedAt""-updatedAt"

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"

Responses

200

The filters have been successfully returned.

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  a list of filters containing all the filters properties (like name,description...) except the filter definition (like FilterV1_0)
  
  Show data properties
  
  id string
  
  The filter ID (bookmarkId)
  
  name string
  
  The filter name.
  
  ownerId string
  
  The user that owns the filter, if missing the same as the request user.
  
  createdAt string
  
  format = "date-time"
  
  updatedAt string
  
  format = "date-time"
  
  filterType string
  
  Can be one of: "REP""SUB"
  
  filterV1_0 object
  
  Show filterV1_0 properties
  
  variables array of objects
  
  The filter variables.
  
  Show variables properties
  
  name string
  
  Required
  
  value string
  
  evaluate boolean
  
  fieldsByState object
  
  Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
  
  Show additional optional properties
  
  object[] array of objects
  
  maxItems = 125
  
  Show object[] properties
  
  name string
  
  Required
  
  values array of objects
  
  The filter values.
  
  minItems = 1
  
  Show values properties
  
  valueType string
  
  Can be one of: "string""number""evaluate""search"
  
  valueAsText string
  
  valueAsNumber number
  
  format = float64
  
  description string
  
  Gets the resource description.
  
  overrideValues boolean
  
  selectExcluded boolean
  
  description string
  
  The filter description.
  
  filterVersion string
  
  Can be one of: "filter-1.0""filter-2.0"
- links object
  
  Required
  
  Show links properties
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  format = "uri"

400

Bad request. Malformed syntax, errors in params.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

401

Unauthorized, JWT invalid or not provided.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

403

Forbidden, user lacks sufficient permissions to access the resource.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

404

Not found.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

500

Internal server error.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

GET /api/v1/apps/{appId}/report-filters

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppReportFilters(
  '11ecf638-0be4-4b94-a9e6-91218f34e175',
  { filterTypes: [] },
)

qlik app report-filter ls \
  --appId '11ecf638-0be4-4b94-a9e6-91218f34e175' \
  --filterTypes 'value'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/report-filters" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "c61841ac-7b35-4434-aa74-4421f10fc68e",
      "name": "Filter 1",
      "ownerId": "649173fbc8ffcfde27412b99",
      "createdAt": "2023-08-09T08:19:37.577Z",
      "updatedAt": "2023-08-09T08:19:37.577Z",
      "filterType": "REP",
      "filterV1_0": {
        "fieldsByState": {
          "$": [
            {
              "name": "Country",
              "values": [
                {
                  "valueType": "string",
                  "valueAsText": "1-Argentina"
                },
                {
                  "valueType": "string",
                  "valueAsText": "4-Brazil"
                }
              ],
              "overrideValues": false,
              "selectExcluded": false
            },
            {
              "name": "Order number",
              "values": [
                {
                  "valueType": "number",
                  "valueAsText": "61300",
                  "valueAsNumber": 61300
                }
              ],
              "overrideValues": false,
              "selectExcluded": false
            }
          ]
        }
      },
      "description": "This is the filter description",
      "filterVersion": "filter-1.0"
    }
  ],
  "links": {
    "next": {
      "href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
    },
    "prev": {
      "href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
    },
    "self": {
      "href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
    }
  }
}

Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"

Request Body

Required

The filter definition.

application/json object
Show application/json properties
- name string
  
  Required
  
  The filter name.
- appId string
  
  The App ID.
- ownerId string
  
  The user that owns the filter, if missing the same as the request user.
- filterType string
  
  Required
  
  Can be one of: "REP""SUB"
- filterV1_0 object
  
  Show filterV1_0 properties
  
  variables array of objects
  
  The filter variables.
  
  Show variables properties
  
  name string
  
  Required
  
  value string
  
  evaluate boolean
  
  fieldsByState object
  
  Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
  
  Show additional optional properties
  
  object[] array of objects
  
  maxItems = 125
  
  Show object[] properties
  
  name string
  
  Required
  
  values array of objects
  
  The filter values.
  
  minItems = 1
  
  Show values properties
  
  valueType string
  
  Can be one of: "string""number""evaluate""search"
  
  valueAsText string
  
  valueAsNumber number
  
  format = float64
  
  description string
  
  Gets the resource description.
  
  overrideValues boolean
  
  selectExcluded boolean
- description string
  
  The filter description.
- filterVersion string
  
  Required
  
  Can be one of: "filter-1.0""filter-2.0"

Responses

201

The filter has been successfully created.

application/json object
Show application/json properties
- id string
  
  The filter ID (bookmarkId).
- name string
  
  Filterable
  
  The filter name.
- ownerId string
  
  The user that owns the filter, if missing the same as the request user.
- createdAt string
  
  format = "date-time"
- updatedAt string
  
  format = "date-time"
- filterType string
  
  Can be one of: "REP""SUB"
- filterV1_0 object
  
  Show filterV1_0 properties
  
  variables array of objects
  
  The filter variables.
  
  Show variables properties
  
  name string
  
  Required
  
  value string
  
  evaluate boolean
  
  fieldsByState object
  
  Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
  
  Show additional optional properties
  
  object[] array of objects
  
  maxItems = 125
  
  Show object[] properties
  
  name string
  
  Required
  
  values array of objects
  
  The filter values.
  
  minItems = 1
  
  Show values properties
  
  valueType string
  
  Can be one of: "string""number""evaluate""search"
  
  valueAsText string
  
  valueAsNumber number
  
  format = float64
  
  description string
  
  Gets the resource description.
  
  overrideValues boolean
  
  selectExcluded boolean
- description string
  
  Filterable
  
  The filter description.
- filterVersion string
  
  Can be one of: "filter-1.0""filter-2.0"

400

Bad request, malformed syntax, errors in params or the report request is not valid.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

401

Unauthorized, JWT invalid or not provided.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

403

Forbidden, user lacks sufficient permissions to access the resource.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

404

Not found.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

409

Filter name conflict.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

500

Internal server error.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

POST /api/v1/apps/{appId}/report-filters

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.createAppReportFilter(
  '11ecf638-0be4-4b94-a9e6-91218f34e175',
  {
    description: 'this is a filter sample',
    filterType: 'REP',
    filterV1_0: {
      fieldsByState: {
        $: [
          {
            name: 'Country',
            values: [
              {
                valueAsText: '1-Argentina',
                valueType: 'string',
              },

              {
                valueAsText: '4-Brazil',
                valueType: 'string',
              },
            ],
          },

          {
            name: 'Order number',
            values: [
              {
                valueAsNumber: 61300,
                valueAsText: '61300',
                valueType: 'number',
              },
            ],
          },
        ],
      },
    },
    filterVersion: 'filter-1.0',
    name: 'Filter sample',
  },
)

qlik app report-filter create \
  --appId '11ecf638-0be4-4b94-a9e6-91218f34e175' \
  --filterType 'REP' \
  --filterV1_0-fieldsByState-name '' \
  --filterV1_0-variables-name '' \
  --filterVersion 'filter-1.0' \
  --name 'Filter sample'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/report-filters" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Filter sample","filterType":"REP","filterV1_0":{"fieldsByState":{"$":[{"name":"Country","values":[{"valueType":"string","valueAsText":"1-Argentina"},{"valueType":"string","valueAsText":"4-Brazil"}],"overrideValues":false,"selectExcluded":false},{"name":"Order number","values":[{"valueType":"number","valueAsText":"61300","valueAsNumber":61300}],"overrideValues":false,"selectExcluded":false}]}},"description":"this is a filter sample","filterVersion":"filter-1.0"}'

Example Response

{
  "id": "c61841ac-7b35-4434-aa74-4421f10fc68e",
  "name": "Filter 1",
  "ownerId": "649173fbc8ffcfde27412b99",
  "createdAt": "2023-08-09T08:19:37.577Z",
  "updatedAt": "2023-08-09T08:19:37.577Z",
  "filterType": "REP",
  "filterV1_0": {
    "fieldsByState": {
      "$": [
        {
          "name": "Country",
          "values": [
            {
              "valueType": "string",
              "valueAsText": "1-Argentina"
            },
            {
              "valueType": "string",
              "valueAsText": "4-Brazil"
            }
          ],
          "overrideValues": false,
          "selectExcluded": false
        },
        {
          "name": "Order number",
          "values": [
            {
              "valueType": "number",
              "valueAsText": "61300",
              "valueAsNumber": 61300
            }
          ],
          "overrideValues": false,
          "selectExcluded": false
        }
      ]
    }
  },
  "description": "This is the filter description",
  "filterVersion": "filter-1.0"
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

loadType string

Load type expressing the kind of request, eg. interactive for report requests from the Web UI, batch for scheduled report generation.

Can be one of: "interactive""batch"
default = "interactive"

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"
id string

Required

The filter id identifier (bookmarkId).

Responses

200

The filter has been successfully returned.

application/json object
Show application/json properties
- id string
  
  The filter ID (bookmarkId).
- name string
  
  Filterable
  
  The filter name.
- ownerId string
  
  The user that owns the filter, if missing the same as the request user.
- createdAt string
  
  format = "date-time"
- updatedAt string
  
  format = "date-time"
- filterType string
  
  Can be one of: "REP""SUB"
- filterV1_0 object
  
  Show filterV1_0 properties
  
  variables array of objects
  
  The filter variables.
  
  Show variables properties
  
  name string
  
  Required
  
  value string
  
  evaluate boolean
  
  fieldsByState object
  
  Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
  
  Show additional optional properties
  
  object[] array of objects
  
  maxItems = 125
  
  Show object[] properties
  
  name string
  
  Required
  
  values array of objects
  
  The filter values.
  
  minItems = 1
  
  Show values properties
  
  valueType string
  
  Can be one of: "string""number""evaluate""search"
  
  valueAsText string
  
  valueAsNumber number
  
  format = float64
  
  description string
  
  Gets the resource description.
  
  overrideValues boolean
  
  selectExcluded boolean
- description string
  
  Filterable
  
  The filter description.
- filterVersion string
  
  Can be one of: "filter-1.0""filter-2.0"

400

Bad request. Malformed syntax, errors in params.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

401

Unauthorized, JWT invalid or not provided.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

403

Forbidden, user lacks sufficient permissions to access the resource.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

404

Not found.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

500

Internal server error.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

GET /api/v1/apps/{appId}/report-filters/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppReportFilter(
  '01562a37-23e3-4b43-865d-84c26122276c',
  '01562a37-23e3-4b43-865d-84c26122276c',
)

qlik app report-filter get '01562a37-23e3-4b43-865d-84c26122276c' \
  --appId '01562a37-23e3-4b43-865d-84c26122276c'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/report-filters/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "c61841ac-7b35-4434-aa74-4421f10fc68e",
  "name": "Filter 1",
  "ownerId": "649173fbc8ffcfde27412b99",
  "createdAt": "2023-08-09T08:19:37.577Z",
  "updatedAt": "2023-08-09T08:19:37.577Z",
  "filterType": "REP",
  "filterV1_0": {
    "fieldsByState": {
      "$": [
        {
          "name": "Country",
          "values": [
            {
              "valueType": "string",
              "valueAsText": "1-Argentina"
            },
            {
              "valueType": "string",
              "valueAsText": "4-Brazil"
            }
          ],
          "overrideValues": false,
          "selectExcluded": false
        },
        {
          "name": "Order number",
          "values": [
            {
              "valueType": "number",
              "valueAsText": "61300",
              "valueAsNumber": 61300
            }
          ],
          "overrideValues": false,
          "selectExcluded": false
        }
      ]
    }
  },
  "description": "This is the filter description",
  "filterVersion": "filter-1.0"
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"
id string

Required

The filter id identifier (bookmarkId).

Request Body

Required

The filter definition that will replace the existing one.

application/json array of objects
Show application/json properties
- op string
  
  Required
  
  operation (replace).
  
  Can be one of: "replace"
- path string
  
  Required
  
  A JSON Pointer path (/).
  
  Can be one of: "/filter"
- value object
  
  Required
  
  The value to be used for this operation. The properties that cannot be patched include id, filterType, appId
  
  Show value properties
  
  Filter object
  
  Show Filter properties
  
  name string
  
  The filter name.
  
  ownerId string
  
  The user that owns the filter, if missing the same as the request user.
  
  filterV1_0 object
  
  Show filterV1_0 properties
  
  variables array of objects
  
  The filter variables.
  
  Show variables properties
  
  name string
  
  Required
  
  value string
  
  evaluate boolean
  
  fieldsByState object
  
  Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
  
  Show additional optional properties
  
  object[] array of objects
  
  maxItems = 125
  
  Show object[] properties
  
  name string
  
  Required
  
  values array of objects
  
  The filter values.
  
  minItems = 1
  
  Show values properties
  
  valueType string
  
  Can be one of: "string""number""evaluate""search"
  
  valueAsText string
  
  valueAsNumber number
  
  format = float64
  
  description string
  
  Gets the resource description.
  
  overrideValues boolean
  
  selectExcluded boolean
  
  description string
  
  The filter description.
  
  filterVersion string
  
  Can be one of: "filter-1.0""filter-2.0"

Responses

204

The filter has been successfully patched.

400

Bad request. Malformed syntax, errors in params.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

401

Unauthorized, JWT invalid or not provided.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

403

Forbidden, user lacks sufficient permissions to access the resource.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

404

Not found.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

409

Filter name conflict. A filter with the same name already exists.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

500

Internal server error.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

PATCH /api/v1/apps/{appId}/report-filters/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.patchAppReportFilter(
  '01562a37-23e3-4b43-865d-84c26122276c',
  '01562a37-23e3-4b43-865d-84c26122276c',
  [
    {
      op: 'replace',
      path: '/filter',
      value: {
        Filter: {
          description:
            'This is the filter description',
          filterV1_0: {
            fieldsByState: {
              $: [
                {
                  name: 'Country',
                  values: [
                    {
                      valueAsText: '1-Argentina',
                      valueType: 'string',
                    },

                    {
                      valueAsText: '4-Brazil',
                      valueType: 'string',
                    },
                  ],
                },

                {
                  name: 'Order number',
                  values: [
                    {
                      valueAsNumber: 61300,
                      valueAsText: '61300',
                      valueType: 'number',
                    },
                  ],
                },
              ],
            },
          },
          filterVersion: 'filter-1.0',
          name: 'Filter 1',
          ownerId: '649173fbc8ffcfde27412b99',
        },
      },
    },
  ],
)

qlik app report-filter patch '01562a37-23e3-4b43-865d-84c26122276c' \
  --appId '01562a37-23e3-4b43-865d-84c26122276c' \
  --op 'replace' \
  --path '/filter' \
  --value-Filter-description 'This is the filter description' \
  --value-Filter-filterV1_0-fieldsByState-description '' \
  --value-Filter-filterV1_0-fieldsByState-name '' \
  --value-Filter-filterV1_0-fieldsByState-overrideValues  \
  --value-Filter-filterV1_0-fieldsByState-selectExcluded  \
  --value-Filter-filterV1_0-fieldsByState-values-valueAsNumber  \
  --value-Filter-filterV1_0-fieldsByState-values-valueAsText '' \
  --value-Filter-filterV1_0-fieldsByState-values-valueType '' \
  --value-Filter-filterV1_0-variables-evaluate  \
  --value-Filter-filterV1_0-variables-name '' \
  --value-Filter-filterV1_0-variables-value '' \
  --value-Filter-filterVersion 'filter-1.0' \
  --value-Filter-name 'Filter 1' \
  --value-Filter-ownerId '649173fbc8ffcfde27412b99'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/report-filters/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/filter","value":{"Filter":{"name":"Filter 1","ownerId":"649173fbc8ffcfde27412b99","filterV1_0":{"fieldsByState":{"$":[{"name":"Country","values":[{"valueType":"string","valueAsText":"1-Argentina"},{"valueType":"string","valueAsText":"4-Brazil"}],"overrideValues":false,"selectExcluded":false},{"name":"Order number","values":[{"valueType":"number","valueAsText":"61300","valueAsNumber":61300}],"overrideValues":false,"selectExcluded":false}]}},"description":"This is the filter description","filterVersion":"filter-1.0"}}}]'

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"
id string

Required

The filter id identifier (bookmarkId).

Responses

204

The filter has been successfully deleted.

400

Bad request. Malformed syntax, errors in params.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

401

Unauthorized, JWT invalid or not provided.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

403

Forbidden, user lacks sufficient permissions to access the resource.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

404

Not found.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

500

Internal server error.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

DELETE /api/v1/apps/{appId}/report-filters/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.deleteAppReportFilter(
  '01562a37-23e3-4b43-865d-84c26122276c',
  '01562a37-23e3-4b43-865d-84c26122276c',
)

qlik app report-filter rm '01562a37-23e3-4b43-865d-84c26122276c' \
  --appId '01562a37-23e3-4b43-865d-84c26122276c'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/report-filters/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filterTypes array of strings

Required

The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.

Values may be any of: "REP""SUB"
minItems = 1

Path Parameters

appId string

Required

Qlik Sense app identifier

format = "uid"

Responses

200

The count of filters.

application/json object
Show application/json properties
- total number
  
  The total number of filters.
  
  format = int32

400

Bad request. Malformed syntax, errors in params.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

401

Unauthorized, JWT invalid or not provided.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

403

Forbidden, user lacks sufficient permissions to access the resource.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

404

Not found.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

500

Internal server error.

application/json object

Errors occured during the Filter creation.
Show application/json properties
- errors array of objects
  
  Required
  
  Error occured during the Filter creation.
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
  
  "REP-400008" Selections error.
  
  "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
  
  "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
  
  "REP-401001" Unauthorized, bad JWT.
  
  "REP-403000" Forbidden. The client does not have access rights to the content.
  
  "REP-403001" App forbidden, the user does not have read permission on the app.
  
  "REP-403002" Chart type not supported.
  
  "REP-404000" Not found. The server can not find the requested resource.
  
  "REP-409043" Filter name conflict. The filter name must be unique.
  
  "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
  
  "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
  
  "REP-429016" Exceeded max session tenant quota per day.
  
  "REP-500000" Fail to resolve resource.
  
  "REP-503005" Engine unavailable, qix-sessions error no engines available.
  
  "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
  
  "REP-504042" Context deadline exceeded applying selections of the Filter.
  
  "REP-500031" Error creating bookmark.
  
  "REP-404032" Bookmark not found after creating the bookmark.
  
  "REP-500033" Error destroying bookmark.
  
  "REP-404033" Bookmark not found destroying the bookmark.
  
  "REP-409043" Dupliacate bookmark name.
  
  "REP-429034" Filters quota exceeded.
  
  "REP-400044" Missing or renamed field.
  
  "REP-403049" Report filter access not allowed.
  
  title string
  
  Required
  
  A summary in english explaining what went wrong.

GET /api/v1/apps/{appId}/report-filters/actions/count

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.countAppReportFilters(
  '01562a37-23e3-4b43-865d-84c26122276c',
  { filterTypes: ['REP'] },
)

qlik app report-filter count '01562a37-23e3-4b43-865d-84c26122276c' \
  --filterTypes 'REP'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/report-filters/actions/count" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "total": 20
}

Retrieves the script history for an app. Returns information about the saved versions of the script in a list sorted with latest first.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filter string
A scim filter expression defining which script versions should be retrieved. Filterable fields are:
- ScriptId
- ModifiedTime
- ModifierId
limit string

Maximum number of records to return from this request.
page string

Opaque definition of which page of the result set to return. Returned from a previous call using the same filter. Not yet supported.

Path Parameters

appId string

Required

Identifier of the app.

Responses

200

OK

application/json object
Show application/json properties
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  prev object
  
  Show prev properties
  
  href string
- scripts array of objects
  
  Script versions metadata.
  
  Show scripts properties
  
  size integer
  
  Script size.
  
  format = int64
  
  scriptId string
  
  Script id.
  
  modifierId string
  
  User last modifying script version.
  
  modifiedTime string
  
  Script version last modification time.
  
  versionMessage string
  
  Description of this script version
- privileges array of strings

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppScriptHistory('string', {})

qlik app script version ls \
  --appId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/scripts" \
-H "Authorization: Bearer <access_token>"

Example Response

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

Sets script for an app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Request Body

Required

The script to set.

*/* object
Show */* properties
- script string
  
  Script text.
- versionMessage string
  
  Description of this script version.

Responses

200

OK

403

Forbidden

404

Not Found

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.updateAppScript('string', {
  script: 'string',
  versionMessage: 'string',
})

qlik app script version create \
  --appId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/scripts" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"script":"string","versionMessage":"string"}'

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

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.
id string

Required

Identifier of the script version, or 'current' for retrieving the current version.

Responses

200

OK

application/json object
Show application/json properties
- script string
  
  Script text.
- versionMessage string
  
  Description of this script version.

GET /api/v1/apps/{appId}/scripts/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppScript('string', 'string')

qlik app script version get 'string' \
  --appId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/scripts/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

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

Updates a specific version of the script for an app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.
id string

Required

Identifier of the script version.

Request Body

Required

Array of patches for the object ScriptVersion.

Patches have limited functionality for this object. Only /versionMessage can be modified using operations add, remove and replace.

*/* array of objects
Show */* properties
- Op string
  
  Can be one of: "add""remove""replace"
- Path string
  
  Path to the property to add, remove or replace.
- Value string
  
  This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""

Responses

200

OK

PATCH /api/v1/apps/{appId}/scripts/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.patchAppScript(
  'string',
  'string',
  [{ Path: 'string', Value: 'string' }],
)

qlik app script version patch 'string' \
  --appId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/scripts/{id}" \
-X PATCH \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '[{"Path":"string","Value":"string"}]'

Deletes a specific version of the script for an app. Fails if the supplied id is the current version.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.
id string

Required

Identifier of the script version

Responses

200

OK

DELETE /api/v1/apps/{appId}/scripts/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.deleteAppScript(
  'string',
  'string',
)

qlik app script version rm 'string' \
  --appId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/scripts/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Sets space on a specific app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Request Body

Required

New space.

*/* object
Show */* properties
- spaceId string

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.moveAppToSpace('string', {
  spaceId: 'string',
})

qlik app space update 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{appId}/space" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"spaceId":"string"}'

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

Removes space from a specific app.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

appId string

Required

Identifier of the app.

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.removeAppFromSpace('string')

qlik app space rm 'string'

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

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

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

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-09
	Deprecated description	Replaced by namespaced API
	Replaced by	GET analytics/apps/{guid}/evaluations

Query Parameters

all boolean

Get the full data of the evaluation
fileMode boolean

Add file transfer headers to response
format string

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

Number of results to return per page.

minimum = 1, maximum = 100, default = 20, format = int32, default = 20
next string

The app evaluation id to get next page from
prev string

The app evaluation id to get previous page from
sort string

Property to sort list on

Path Parameters

guid string

Required

The app guid.

Responses

200

Evaluation(s) retrieved successfully.

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  format = "string"
  
  appId string
  
  format = "string"
  
  ended string
  
  format = "date-time"
  
  events array of objects
  
  Show events properties
  
  details string
  
  sheetId string
  
  objectId string
  
  severity string
  
  errorCode string
  
  objectType string
  
  sheetTitle string
  
  objectTitle string
  
  objectVisualization string
  
  result object
  
  Show result properties
  
  sheets array of objects
  
  Show sheets properties
  
  sheet object
  
  Show sheet properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  objectCount number
  
  sheetObjects array of objects
  
  Show sheetObjects properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  rowCount number
  
  objNoCache array of objects
  
  Show objNoCache properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  sheetCount number
  
  objectCount number
  
  objSlowCached array of objects
  
  Show objSlowCached properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  objMemoryLimit array of objects
  
  Show objMemoryLimit properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  memoryLimitStatusCode string
  
  documentSizeMiB number
  
  objSlowUncached array of objects
  
  Show objSlowUncached properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  hasSectionAccess boolean
  
  topFieldsByBytes array of objects
  
  Show topFieldsByBytes properties
  
  name string
  
  byte_size number
  
  is_system boolean
  
  topTablesByBytes array of objects
  
  Show topTablesByBytes properties
  
  name string
  
  byte_size number
  
  is_system boolean
  
  objSingleThreaded array of objects
  
  Show objSingleThreaded properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuQuotient1 number
  
  status string
  
  format = "string"
  
  appName string
  
  format = "string"
  
  details object
  
  Show details properties
  
  errors array of strings
  
  warnings array of strings
  
  dedicated boolean
  
  objectMetrics object
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  passes array of objects
  
  Show passes properties
  
  cpuSeconds array of numbers
  
  cpuQuotients array of numbers
  
  responseTimeSeconds number
  
  engineHasCache boolean
  
  concurrentReload boolean
  
  sheetId string
  
  format = "string"
  
  started string
  
  format = "date-time"
  
  version number
  
  metadata object
  
  Show metadata properties
  
  reloadmeta object
  
  Show reloadmeta properties
  
  cpuspent number
  
  peakmemorybytes number
  
  amountofrows number
  
  amountoffields number
  
  amountoftables number
  
  staticbytesize number
  
  hassectionaccess boolean
  
  amountoffieldvalues number
  
  amountofcardinalfieldvalues number
  
  tenantId string
  
  format = "string"
  
  appItemId string
  
  format = "string"
  
  timestamp string
  
  format = "date-time"
  
  sheetTitle string
  
  format = "string"
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  prev object
  
  Show prev properties
  
  href string

400

Bad request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppEvaluations(
  'abcdefghijklmnopq',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/apps/{guid}/evaluations yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{guid}/evaluations" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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": "table",
              "timeoutStatusCode": "CALC-TIMEOUT",
              "responseTimeSeconds": 12.3
            },
            "objectCount": 1,
            "sheetObjects": [
              {
                "id": "fjETFn",
                "title": "my chart",
                "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
                "objectType": "table",
                "timeoutStatusCode": "CALC-TIMEOUT",
                "responseTimeSeconds": 12.3
              }
            ]
          }
        ],
        "rowCount": 20000,
        "objNoCache": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": "table",
            "timeoutStatusCode": "CALC-TIMEOUT",
            "responseTimeSeconds": 12.3
          }
        ],
        "sheetCount": 5,
        "objectCount": 33,
        "objSlowCached": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": "table",
            "timeoutStatusCode": "CALC-TIMEOUT",
            "responseTimeSeconds": 12.3
          }
        ],
        "objMemoryLimit": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": "table",
            "memoryLimitStatusCode": "OUT-OF-MEMORY"
          }
        ],
        "documentSizeMiB": 12.3,
        "objSlowUncached": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": "table",
            "timeoutStatusCode": "CALC-TIMEOUT",
            "responseTimeSeconds": 12.3
          }
        ],
        "hasSectionAccess": false,
        "topFieldsByBytes": [
          {
            "name": "a",
            "byte_size": 1234,
            "is_system": false
          }
        ],
        "topTablesByBytes": [
          {
            "name": "a",
            "byte_size": 1234,
            "is_system": false
          }
        ],
        "objSingleThreaded": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": "table",
            "cpuQuotient1": 12.3
          }
        ]
      },
      "status": "finished",
      "appName": "my app",
      "details": {
        "errors": [
          "this is an error"
        ],
        "warnings": [
          "this is a warning"
        ],
        "dedicated": false,
        "objectMetrics": {},
        "engineHasCache": false,
        "concurrentReload": false
      },
      "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": false,
        "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 by its app guid.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-09
	Deprecated description	Replaced by namespaced API
	Replaced by	POST analytics/apps/{guid}/evaluations

Path Parameters

guid string

Required

Guid of the app.

Responses

201

App evaluation queued.

application/json object
Show application/json properties
- id string
  
  format = "string"
- appId string
  
  format = "string"
- ended string
  
  format = "date-time"
- events array of objects
  
  Show events properties
  
  details string
  
  sheetId string
  
  objectId string
  
  severity string
  
  errorCode string
  
  objectType string
  
  sheetTitle string
  
  objectTitle string
  
  objectVisualization string
- result object
  
  Show result properties
  
  sheets array of objects
  
  Show sheets properties
  
  sheet object
  
  Show sheet properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  objectCount number
  
  sheetObjects array of objects
  
  Show sheetObjects properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  rowCount number
  
  objNoCache array of objects
  
  Show objNoCache properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  sheetCount number
  
  objectCount number
  
  objSlowCached array of objects
  
  Show objSlowCached properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  objMemoryLimit array of objects
  
  Show objMemoryLimit properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  memoryLimitStatusCode string
  
  documentSizeMiB number
  
  objSlowUncached array of objects
  
  Show objSlowUncached properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  hasSectionAccess boolean
  
  topFieldsByBytes array of objects
  
  Show topFieldsByBytes properties
  
  name string
  
  byte_size number
  
  is_system boolean
  
  topTablesByBytes array of objects
  
  Show topTablesByBytes properties
  
  name string
  
  byte_size number
  
  is_system boolean
  
  objSingleThreaded array of objects
  
  Show objSingleThreaded properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuQuotient1 number
- status string
  
  format = "string"
- appName string
  
  format = "string"
- details object
  
  Show details properties
  
  errors array of strings
  
  warnings array of strings
  
  dedicated boolean
  
  objectMetrics object
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  passes array of objects
  
  Show passes properties
  
  cpuSeconds array of numbers
  
  cpuQuotients array of numbers
  
  responseTimeSeconds number
  
  engineHasCache boolean
  
  concurrentReload boolean
- sheetId string
  
  format = "string"
- started string
  
  format = "date-time"
- version number
- metadata object
  
  Show metadata properties
  
  reloadmeta object
  
  Show reloadmeta properties
  
  cpuspent number
  
  peakmemorybytes number
  
  amountofrows number
  
  amountoffields number
  
  amountoftables number
  
  staticbytesize number
  
  hassectionaccess boolean
  
  amountoffieldvalues number
  
  amountofcardinalfieldvalues number
- tenantId string
  
  format = "string"
- appItemId string
  
  format = "string"
- timestamp string
  
  format = "date-time"
- sheetTitle string
  
  format = "string"

400

Bad request, incorrect body.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

403

User lacks permissions to evaluate app.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

404

App does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.queueAppEvaluation(
  'abcdefghijklmnopq',
)

# qlik-cli has not implemented support for POST /api/v1/apps/{guid}/evaluations yet.

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

Example Response

{
  "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": "table",
          "timeoutStatusCode": "CALC-TIMEOUT",
          "responseTimeSeconds": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": "table",
            "timeoutStatusCode": "CALC-TIMEOUT",
            "responseTimeSeconds": 12.3
          }
        ]
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "sheetCount": 5,
    "objectCount": 33,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "objMemoryLimit": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "memoryLimitStatusCode": "OUT-OF-MEMORY"
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "hasSectionAccess": false,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": false
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": false
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuQuotient1": 12.3
      }
    ]
  },
  "status": "finished",
  "appName": "my app",
  "details": {
    "errors": [
      "this is an error"
    ],
    "warnings": [
      "this is a warning"
    ],
    "dedicated": false,
    "objectMetrics": {},
    "engineHasCache": false,
    "concurrentReload": false
  },
  "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": false,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

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

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-09
	Deprecated description	Replaced by namespaced API
	Replaced by	GET analytics/apps/evaluations/{baselineId}/compare/{comparisonId}

Query Parameters

all boolean

Get the full list of comparisons including non-significant diffs
format string

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

Path Parameters

baseid string

Required

Id of the baseline evaluation
comparisonid string

Required

Id of the comparison evaluation

Responses

200

Comparison executed successfully.

application/json object
Show application/json properties
- objHeavy object
  
  Show objHeavy properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
- rowCount object
  
  Show rowCount properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- objNoCache object
  
  Show objNoCache properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- sheetCount object
  
  Show sheetCount properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- fileSizeMib object
  
  Show fileSizeMib properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- objectCount object
  
  Show objectCount properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- maxMemoryMib object
  
  Show maxMemoryMib properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- sheetsCached object
  
  Show sheetsCached properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- objSlowCached object
  
  Show objSlowCached properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- objMemoryLimit array of objects
  
  Show objMemoryLimit properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  baselineMemoryLimitStatusCode string
  
  comparisonMemoryLimitStatusCode string
- sheetsUncached object
  
  Show sheetsUncached properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- documentSizeMib object
  
  Show documentSizeMib properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- objSlowUncached object
  
  Show objSlowUncached properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- dataModelSizeMib object
  
  Show dataModelSizeMib properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- hasSectionAccess object
  
  Show hasSectionAccess properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
- topFieldsByBytes object
  
  Show topFieldsByBytes properties
  
  list array of objects
  
  Show list properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
- topTablesByBytes object
  
  Show topTablesByBytes properties
  
  list array of objects
  
  Show list properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
- objSingleThreaded object
  
  Show objSingleThreaded properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- appOpenTimeSeconds object
  
  Show appOpenTimeSeconds properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppEvaluationComparison(
  'abcdefghijklmnopq',
  'abcdefghijklmnopq',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid} yet.

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

Example Response

{
  "objHeavy": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "rowCount": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1,
    "comparison": 2
  },
  "objNoCache": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "sheetCount": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1,
    "comparison": 2
  },
  "fileSizeMib": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  },
  "objectCount": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1,
    "comparison": 2
  },
  "maxMemoryMib": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  },
  "sheetsCached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "objSlowCached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "objMemoryLimit": [
    {
      "id": "fjETFn",
      "title": "my chart",
      "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
      "objectType": "table",
      "dataSourceStatus": "full",
      "baselineMemoryLimitStatusCode": "OUT-OF-MEMORY",
      "comparisonMemoryLimitStatusCode": "OUT-OF-MEMORY"
    }
  ],
  "sheetsUncached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "documentSizeMib": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  },
  "objSlowUncached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "dataModelSizeMib": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  },
  "hasSectionAccess": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": false,
    "comparison": true
  },
  "topFieldsByBytes": {
    "list": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "topTablesByBytes": {
    "list": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "objSingleThreaded": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "appOpenTimeSeconds": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  }
}

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

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-09
	Deprecated description	Replaced by namespaced API
	Replaced by	GET analytics/apps/evaluations/{baselineId}/compare/{comparisonId}/actions/download

Path Parameters

baseid string

Required

Id of the baseline evaluation
comparisonid string

Required

Id of the comparison evaluation

Responses

200

Comparison executed successfully.

application/json object
Show application/json properties
- objHeavy object
  
  Show objHeavy properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuSeconds1 object
  
  Show cpuSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuSeconds2 object
  
  Show cpuSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient1 object
  
  Show cpuQuotient1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  cpuQuotient2 object
  
  Show cpuQuotient2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
- rowCount object
  
  Show rowCount properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- objNoCache object
  
  Show objNoCache properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- sheetCount object
  
  Show sheetCount properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- fileSizeMib object
  
  Show fileSizeMib properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- objectCount object
  
  Show objectCount properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- maxMemoryMib object
  
  Show maxMemoryMib properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- sheetsCached object
  
  Show sheetsCached properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- objSlowCached object
  
  Show objSlowCached properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- objMemoryLimit array of objects
  
  Show objMemoryLimit properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  baselineMemoryLimitStatusCode string
  
  comparisonMemoryLimitStatusCode string
- sheetsUncached object
  
  Show sheetsUncached properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- documentSizeMib object
  
  Show documentSizeMib properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- objSlowUncached object
  
  Show objSlowUncached properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- dataModelSizeMib object
  
  Show dataModelSizeMib properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
- hasSectionAccess object
  
  Show hasSectionAccess properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
- topFieldsByBytes object
  
  Show topFieldsByBytes properties
  
  list array of objects
  
  Show list properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  cardinal object
  
  Show cardinal properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  total_count object
  
  Show total_count properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
- topTablesByBytes object
  
  Show topTablesByBytes properties
  
  list array of objects
  
  Show list properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  name string
  
  byte_size object
  
  Show byte_size properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  is_system object
  
  Show is_system properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline boolean
  
  comparison boolean
  
  no_of_rows object
  
  Show no_of_rows properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
- objSingleThreaded object
  
  Show objSingleThreaded properties
  
  list array of objects
  
  Show list properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffAsc array of objects
  
  Show absoluteDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  relativeDiffAsc array of objects
  
  Show relativeDiffAsc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  absoluteDiffDesc array of objects
  
  Show absoluteDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  relativeDiffDesc array of objects
  
  Show relativeDiffDesc properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  dataSourceStatus string
  
  Can be one of: "full""none""baselinemissing""comparisonmissing"
  
  responseTimeSeconds1 object
  
  Show responseTimeSeconds1 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
  
  responseTimeSeconds2 object
  
  Show responseTimeSeconds2 properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number
  
  baselineTimeoutStatusCode string
  
  comparisonTimeoutStatusCode string
- appOpenTimeSeconds object
  
  Show appOpenTimeSeconds properties
  
  diff number
  
  trend string
  
  absoluteDiff number
  
  baseline number
  
  comparison number

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppEvaluationComparisonXml(
  'abcdefghijklmnopq',
  'abcdefghijklmnopq',
)

# qlik-cli has not implemented support for GET /api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download yet.

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

Example Response

{
  "objHeavy": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "cpuQuotient2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "rowCount": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1,
    "comparison": 2
  },
  "objNoCache": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "sheetCount": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1,
    "comparison": 2
  },
  "fileSizeMib": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  },
  "objectCount": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1,
    "comparison": 2
  },
  "maxMemoryMib": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  },
  "sheetsCached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "objSlowCached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "objMemoryLimit": [
    {
      "id": "fjETFn",
      "title": "my chart",
      "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
      "objectType": "table",
      "dataSourceStatus": "full",
      "baselineMemoryLimitStatusCode": "OUT-OF-MEMORY",
      "comparisonMemoryLimitStatusCode": "OUT-OF-MEMORY"
    }
  ],
  "sheetsUncached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "documentSizeMib": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  },
  "objSlowUncached": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "dataModelSizeMib": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  },
  "hasSectionAccess": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": false,
    "comparison": true
  },
  "topFieldsByBytes": {
    "list": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "cardinal": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "total_count": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "topTablesByBytes": {
    "list": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "relativeDiffAsc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "absoluteDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "name": "a",
        "byte_size": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "is_system": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": false,
          "comparison": true
        },
        "no_of_rows": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1,
          "comparison": 2
        },
        "dataSourceStatus": "full"
      }
    ]
  },
  "objSingleThreaded": {
    "list": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "relativeDiffAsc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "absoluteDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ],
    "dataSourceStatus": "full",
    "relativeDiffDesc": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "dataSourceStatus": "full",
        "responseTimeSeconds1": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        },
        "responseTimeSeconds2": {
          "diff": 0.5,
          "trend": "up",
          "absoluteDiff": 2.5,
          "baseline": 1.1,
          "comparison": 2.2,
          "baselineTimeoutStatusCode": "CALC-TIMEOUT",
          "comparisonTimeoutStatusCode": "CALC-TIMEOUT"
        }
      }
    ]
  },
  "appOpenTimeSeconds": {
    "diff": 0.5,
    "trend": "up",
    "absoluteDiff": 2.5,
    "baseline": 1.1,
    "comparison": 2.2
  }
}

Find an evaluation by a specific id.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-09
	Deprecated description	Replaced by namespaced API
	Replaced by	GET analytics/apps/evaluations/{id}

Query Parameters

all boolean

Get the full data of the evaluation
format string

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

Path Parameters

id string

Required

Id of the desired evaluation.

Responses

200

Evaluation(s) retrieved successfully.

application/json object
Show application/json properties
- id string
  
  format = "string"
- appId string
  
  format = "string"
- ended string
  
  format = "date-time"
- events array of objects
  
  Show events properties
  
  details string
  
  sheetId string
  
  objectId string
  
  severity string
  
  errorCode string
  
  objectType string
  
  sheetTitle string
  
  objectTitle string
  
  objectVisualization string
- result object
  
  Show result properties
  
  sheets array of objects
  
  Show sheets properties
  
  sheet object
  
  Show sheet properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  objectCount number
  
  sheetObjects array of objects
  
  Show sheetObjects properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  rowCount number
  
  objNoCache array of objects
  
  Show objNoCache properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  sheetCount number
  
  objectCount number
  
  objSlowCached array of objects
  
  Show objSlowCached properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  objMemoryLimit array of objects
  
  Show objMemoryLimit properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  memoryLimitStatusCode string
  
  documentSizeMiB number
  
  objSlowUncached array of objects
  
  Show objSlowUncached properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  hasSectionAccess boolean
  
  topFieldsByBytes array of objects
  
  Show topFieldsByBytes properties
  
  name string
  
  byte_size number
  
  is_system boolean
  
  topTablesByBytes array of objects
  
  Show topTablesByBytes properties
  
  name string
  
  byte_size number
  
  is_system boolean
  
  objSingleThreaded array of objects
  
  Show objSingleThreaded properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuQuotient1 number
- status string
  
  format = "string"
- appName string
  
  format = "string"
- details object
  
  Show details properties
  
  errors array of strings
  
  warnings array of strings
  
  dedicated boolean
  
  objectMetrics object
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  passes array of objects
  
  Show passes properties
  
  cpuSeconds array of numbers
  
  cpuQuotients array of numbers
  
  responseTimeSeconds number
  
  engineHasCache boolean
  
  concurrentReload boolean
- sheetId string
  
  format = "string"
- started string
  
  format = "date-time"
- version number
- metadata object
  
  Show metadata properties
  
  reloadmeta object
  
  Show reloadmeta properties
  
  cpuspent number
  
  peakmemorybytes number
  
  amountofrows number
  
  amountoffields number
  
  amountoftables number
  
  staticbytesize number
  
  hassectionaccess boolean
  
  amountoffieldvalues number
  
  amountofcardinalfieldvalues number
- tenantId string
  
  format = "string"
- appItemId string
  
  format = "string"
- timestamp string
  
  format = "date-time"
- sheetTitle string
  
  format = "string"

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppEvaluation(
  'abcdefghijklmnopq',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/apps/evaluations/{id} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/evaluations/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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": "table",
          "timeoutStatusCode": "CALC-TIMEOUT",
          "responseTimeSeconds": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": "table",
            "timeoutStatusCode": "CALC-TIMEOUT",
            "responseTimeSeconds": 12.3
          }
        ]
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "sheetCount": 5,
    "objectCount": 33,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "objMemoryLimit": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "memoryLimitStatusCode": "OUT-OF-MEMORY"
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "hasSectionAccess": false,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": false
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": false
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuQuotient1": 12.3
      }
    ]
  },
  "status": "finished",
  "appName": "my app",
  "details": {
    "errors": [
      "this is an error"
    ],
    "warnings": [
      "this is a warning"
    ],
    "dedicated": false,
    "objectMetrics": {},
    "engineHasCache": false,
    "concurrentReload": false
  },
  "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": false,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

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

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-09
	Deprecated description	Replaced by namespaced API
	Replaced by	GET analytics/apps/evaluations/{id}/actions/download

Path Parameters

id string

Required

Id of the desired evaluation.

Responses

200

Evaluation(s) retrieved successfully.

application/json object
Show application/json properties
- id string
  
  format = "string"
- appId string
  
  format = "string"
- ended string
  
  format = "date-time"
- events array of objects
  
  Show events properties
  
  details string
  
  sheetId string
  
  objectId string
  
  severity string
  
  errorCode string
  
  objectType string
  
  sheetTitle string
  
  objectTitle string
  
  objectVisualization string
- result object
  
  Show result properties
  
  sheets array of objects
  
  Show sheets properties
  
  sheet object
  
  Show sheet properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  objectCount number
  
  sheetObjects array of objects
  
  Show sheetObjects properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  rowCount number
  
  objNoCache array of objects
  
  Show objNoCache properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  sheetCount number
  
  objectCount number
  
  objSlowCached array of objects
  
  Show objSlowCached properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  objMemoryLimit array of objects
  
  Show objMemoryLimit properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  memoryLimitStatusCode string
  
  documentSizeMiB number
  
  objSlowUncached array of objects
  
  Show objSlowUncached properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  timeoutStatusCode string
  
  responseTimeSeconds number
  
  hasSectionAccess boolean
  
  topFieldsByBytes array of objects
  
  Show topFieldsByBytes properties
  
  name string
  
  byte_size number
  
  is_system boolean
  
  topTablesByBytes array of objects
  
  Show topTablesByBytes properties
  
  name string
  
  byte_size number
  
  is_system boolean
  
  objSingleThreaded array of objects
  
  Show objSingleThreaded properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  cpuQuotient1 number
- status string
  
  format = "string"
- appName string
  
  format = "string"
- details object
  
  Show details properties
  
  errors array of strings
  
  warnings array of strings
  
  dedicated boolean
  
  objectMetrics object
  
  Show additional optional properties
  
  object object
  
  Show object properties
  
  id string
  
  format = "string"
  
  title string
  
  format = "string"
  
  sheetId string
  
  format = "string"
  
  objectType string
  
  passes array of objects
  
  Show passes properties
  
  cpuSeconds array of numbers
  
  cpuQuotients array of numbers
  
  responseTimeSeconds number
  
  engineHasCache boolean
  
  concurrentReload boolean
- sheetId string
  
  format = "string"
- started string
  
  format = "date-time"
- version number
- metadata object
  
  Show metadata properties
  
  reloadmeta object
  
  Show reloadmeta properties
  
  cpuspent number
  
  peakmemorybytes number
  
  amountofrows number
  
  amountoffields number
  
  amountoftables number
  
  staticbytesize number
  
  hassectionaccess boolean
  
  amountoffieldvalues number
  
  amountofcardinalfieldvalues number
- tenantId string
  
  format = "string"
- appItemId string
  
  format = "string"
- timestamp string
  
  format = "date-time"
- sheetTitle string
  
  format = "string"

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  status integer
  
  format = int32

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppEvaluationXml(
  'abcdefghijklmnopq',
)

# qlik-cli has not implemented support for GET /api/v1/apps/evaluations/{id}/actions/download yet.

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

Example Response

{
  "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": "table",
          "timeoutStatusCode": "CALC-TIMEOUT",
          "responseTimeSeconds": 12.3
        },
        "objectCount": 1,
        "sheetObjects": [
          {
            "id": "fjETFn",
            "title": "my chart",
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "objectType": "table",
            "timeoutStatusCode": "CALC-TIMEOUT",
            "responseTimeSeconds": 12.3
          }
        ]
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "sheetCount": 5,
    "objectCount": 33,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "objMemoryLimit": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "memoryLimitStatusCode": "OUT-OF-MEMORY"
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "timeoutStatusCode": "CALC-TIMEOUT",
        "responseTimeSeconds": 12.3
      }
    ],
    "hasSectionAccess": false,
    "topFieldsByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": false
      }
    ],
    "topTablesByBytes": [
      {
        "name": "a",
        "byte_size": 1234,
        "is_system": false
      }
    ],
    "objSingleThreaded": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": "table",
        "cpuQuotient1": 12.3
      }
    ]
  },
  "status": "finished",
  "appName": "my app",
  "details": {
    "errors": [
      "this is an error"
    ],
    "warnings": [
      "this is a warning"
    ],
    "dedicated": false,
    "objectMetrics": {},
    "engineHasCache": false,
    "concurrentReload": false
  },
  "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": false,
    "amountoffieldvalues": 144423433,
    "amountofcardinalfieldvalues": 14442
  },
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "timestamp": "2022-02-09T06:58:40.575Z",
  "sheetTitle": "my sheet"
}

Imports an app into the system.

Facts

Rate limit

Tier 2 (100 requests per minute)

Query Parameters

appId string

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

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

The file ID to be downloaded from Temporary Content Service (TCS) and used during import.
mode string
The import mode. In new mode (default), the source app is imported as a new app.
The autoreplace mode is intended for internal use only and is not permitted for external use.

One of:
- NEW
- AUTOREPLACE
name string

The name of the target app.
NoData boolean

If NoData is true, the data of the existing app will be kept as is, otherwise it will be replaced by the new incoming data.
spaceId string

The space ID of the target app.

Request Body

Path of the source app.

application/octet-stream string

format = "binary"

Responses

200

OK

application/json object

Application attributes and user privileges.
Show application/json properties
- create array of objects
  
  Object create privileges. Hints to the client what type of objects the user is allowed to create.
  
  Show create properties
  
  resource string
  
  Type of resource. For example, sheet, story, bookmark, etc.
  
  canCreate boolean
  
  Is set to true if the user has privileges to create the resource.
- attributes object
  
  App attributes. This structure can include additional user-defined attributes.
  
  Show attributes properties
  
  id string
  
  The App ID.
  
  name string
  
  App name.
  
  owner string Deprecated
  
  Deprecated: Use the Users API to fetch user metadata.
  
  usage string
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
  
  custom object
  
  Contains dynamic JSON data specified by the client.
  
  ownerId string
  
  Identifier of the app owner.
  
  encrypted boolean
  
  If set to true, the app is encrypted.
  
  published boolean
  
  For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published.
  
  thumbnail string
  
  App thumbnail.
  
  createdDate string
  
  The date and time when the app was created.
  
  format = "date-time"
  
  description string
  
  App description.
  
  originAppId string
  
  The Origin App ID for published apps.
  
  publishTime string
  
  The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud.
  
  format = "date-time"
  
  dynamicColor string
  
  The dynamic color of the app.
  
  modifiedDate string
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  lastReloadTime string
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  hasSectionAccess boolean
  
  If set to true, the app has section access configured,
  
  isDirectQueryMode boolean
  
  True if the app is a Direct Query app, false if not
- privileges array of strings
  
  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

404

Not Found

POST /api/v1/apps/import

import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.importApp(
  {},
  new Uint8Array(readFileSync('<file-path>')),
)

qlik app import

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/import" \
-X POST \
-H "Content-type: application/octet-stream" \
-H "Authorization: Bearer <access_token>" \
--data-binary' \
          '"@/path/to/file"

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "custom": {},
    "ownerId": "string",
    "encrypted": true,
    "published": true,
    "thumbnail": "string",
    "createdDate": "2018-10-30T07:06:22Z",
    "description": "string",
    "originAppId": "string",
    "publishTime": "2018-10-30T07:06:22Z",
    "dynamicColor": "string",
    "modifiedDate": "2018-10-30T07:06:22Z",
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "hasSectionAccess": true,
    "isDirectQueryMode": true
  },
  "privileges": [
    "string"
  ]
}

Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

200

OK

application/json array of strings

Values may be any of: "can_create_app""can_import_app""can_create_session_app"

GET /api/v1/apps/privileges

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.getAppsPrivileges()

qlik app privileges

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/privileges" \
-H "Authorization: Bearer <access_token>"

Example Response

[]

Validates the script.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

Script to validate.

*/* object
Show */* properties
- script string

Responses

200

OK

application/json object
Show application/json properties
- Errors array of objects
  
  Show Errors properties
  
  Msg string
  
  Error or warning string. What is the problem.
  
  Tab integer
  
  The index of the tab for the issue.
  
  format = int32
  
  Info string
  
  Additional information like workarounds or clarifications.
  
  Line integer
  
  Line in the tab of the issue.
  
  format = int32
  
  Column integer
  
  UTF-8 byte column of the issue.
  
  format = int32
- Warnings array of objects
  
  Show Warnings properties
  
  Msg string
  
  Error or warning string. What is the problem.
  
  Tab integer
  
  The index of the tab for the issue.
  
  format = int32
  
  Info string
  
  Additional information like workarounds or clarifications.
  
  Line integer
  
  Line in the tab of the issue.
  
  format = int32
  
  Column integer
  
  UTF-8 byte column of the issue.
  
  format = int32

403

Forbidden

POST /api/v1/apps/validatescript

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.apps.validateScript({
  script: 'string',
})

qlik app validatescript

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/validatescript" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <access_token>" \
-d '{"script":"string"}'

Example Response

{
  "Errors": [
    {
      "Msg": "string",
      "Tab": 42,
      "Info": "string",
      "Line": 42,
      "Column": 42
    }
  ],
  "Warnings": [
    {
      "Msg": "string",
      "Tab": 42,
      "Info": "string",
      "Line": 42,
      "Column": 42
    }
  ]
}

Apps

Endpoints

Creates a new app.

Facts

Request Body

Responses

200

Example Response

Retrieves information for a specific app.

Facts

Path Parameters

Responses

200

Example Response

Updates the information for a specific app.

Facts

Path Parameters

Request Body

Responses

200

Example Response

Deletes a specific app.

Facts

Path Parameters

Responses

200

Copies a specific app.

Facts

Path Parameters

Request Body

Responses

200

Example Response

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

Facts

Path Parameters

Responses

200

Example Response

Retrieves the data model and reload statistics metadata of an app. An empty metadata structure is returned if the metadata is not available in the app.

Facts

Path Parameters

Responses

200

Formatting mechanism

Type is DATE, TIME, TIMESTAMP or INTERVAL

Type is INTEGER

Type is REAL

Type is FIX

Type is MONEY

Type is ASCII

Example Response

Exports a specific app.

Facts

Query Parameters

Path Parameters

Responses

201

400

401

403

404

Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields.

Facts

Header Parameters

Path Parameters

Responses

200

400

401

404

422

500

Example Response

Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.

Facts

Header Parameters

Path Parameters

Request Body

Responses