Evaluations

The `app-evaluator` service is responsible for running in-cluster performance and scalability tests/evaluations of apps

Download specification

Retrieve a list of all historic evaluations for app item id or an app GUID

Find all evaluations for an app item id or GUID. appId or itemId has to be set in a query parameter. NOTE: It is preferred to use the app item id as this lookup is more performant. Supports paging via next, prev which are sent in the response body

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Query Parameters

  • allboolean

    Get the full data of the evaluation

  • appIdstring

    The app guid.

  • fileModeboolean

    Add file transfer headers to response

  • formatstring

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

  • itemIdstring

    The app item id.

  • limitinteger

    Number of results to return per page.

  • nextstring

    The app evaluation id to get next page from

  • prevstring

    The app evaluation id to get previous page from

Responses

200

application/json

Evaluation(s) retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • linksobject
      Show links properties
      • nextstring
      • prevstring
    • evaluationsarray of objects

404

application/json

Not Found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger
GET /v1/evaluations
curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/evaluations',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
qlik evaluation ls

Response

{
  "links": {
    "next": "/api/v1/evaluations/appId=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35"
  },
  "evaluations": [
    {}
  ]
}

Queue an app evaluation

Queue an app evaluation by its item id or app guid. NOTE: It is preferred to use the app item id as this lookup is more performant.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalbuild
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Request Body

Required

application/json

The parameters of the evaluation

  • application/jsonobject
    Show application/json properties
    • appIdstring

      The app guid of the app

    • itemIdstring

      The item id of the app in collection service

Responses

201

application/json

App evaluation queued.

  • application/jsonobject
    Show application/json properties
    • idstring
    • appIdstring
    • endedstring
    • eventsarray of objects
    • resultobject
      Show result properties
      • sheetsarray of objects
      • objHeavyarray of objects
        Show objHeavy properties
        • idstring
        • titlestring
        • sheetIdstring
        • objectTypenumber
        • cpuSeconds1number
        • cpuSeconds2number
        • cpuQuotient1number
        • cpuQuotient2number
      • rowCountnumber
      • objNoCachearray of objects
      • sheetCountnumber
      • fileSizeMiBnumber
      • objectCountnumber
      • maxMemoryMiBnumber
      • objSlowCachedarray of objects
        Show objSlowCached properties
        • idstring
        • titlestring
        • sheetIdstring
        • objectTypenumber
        • schemaobject
          Show schema properties
          • idstring
          • titlestring
          • sheetIdstring
          • objectTypenumber
        • cpuQuotients1array of numbers
        • cpuQuotients2array of numbers
        • responseTimeSeconds1number
        • responseTimeSeconds2number
      • documentSizeMiBnumber
      • objSlowUncachedarray of objects
      • dataModelSizeMiBnumber
      • hasSectionAccessboolean
      • topFieldsByBytesarray of objects
      • topTablesByBytesarray of objects
      • objSingleThreadedarray of objects
      • appOpenTimeSecondsnumber
    • statusstring
    • userIdstring
    • appNamestring
    • detailsobject
      Show details properties
      • errorsarray of strings
      • openAppobject
        Show openApp properties
        • cpuSecondsarray of numbers
        • cpuQuotientsarray of numbers
        • responseTimeSecondsnumber
      • warningsarray of strings
      • dedicatedboolean
      • fileSizeMiBnumber
      • objectMetricsobject
      • openAppCachedobject
        Show openAppCached properties
        • cpuSecondsarray of numbers
        • cpuQuotientsarray of numbers
        • responseTimeSecondsnumber
      • engineHasCacheboolean
      • concurrentReloadboolean
      • minMemoryFreeMiBnumber
      • maxMemoryUsageMiBnumber
      • physicalMemoryMiBnumber
      • maxMemoryCachedMiBnumber
      • maxMemoryNotFreeMiBnumber
      • maxMemoryWorkingMiBnumber
    • sheetIdstring
    • spaceIdstring
    • startedstring
    • versionnumber
    • metadataobject
      Show metadata properties
      • reloadmetaobject
        Show reloadmeta properties
        • cpuspentnumber
        • peakmemorybytesnumber
      • amountofrowsnumber
      • amountoffieldsnumber
      • amountoftablesnumber
      • staticbytesizenumber
      • hassectionaccessboolean
      • amountoffieldvaluesnumber
      • amountofcardinalfieldvaluesnumber
    • tenantIdstring
    • appItemIdstring
    • timestampstring
    • sheetTitlestring

400

application/json

Bad request, incorrect body.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger

403

application/json

User lacks permissions to evaluate app.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger
POST /v1/evaluations
curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"appId":"7c2ce11d-4d10-4414-a9b0-620e57298038","itemId":"5e6f8cc63d33cc00018db30b"}'
const https = require('https')
  const data = JSON.stringify({"appId":"7c2ce11d-4d10-4414-a9b0-620e57298038","itemId":"5e6f8cc63d33cc00018db30b"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/evaluations',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
qlik evaluation create \
--appId="7c2ce11d-4d10-4414-a9b0-620e57298038" \
--itemId="5e6f8cc63d33cc00018db30b"

Request

{
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "itemId": "5e6f8cc63d33cc00018db30b"
}

Response

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {}
  ],
  "result": {
    "sheets": [
      {}
    ],
    "objHeavy": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "cpuSeconds1": 12.3,
        "cpuSeconds2": 12.3,
        "cpuQuotient1": 12.3,
        "cpuQuotient2": 12.3
      }
    ],
    "rowCount": 20000,
    "objNoCache": [
      {}
    ],
    "sheetCount": 5,
    "fileSizeMiB": 12.3,
    "objectCount": 33,
    "maxMemoryMiB": 12.3,
    "objSlowCached": [
      {
        "id": "fjETFn",
        "title": "my chart",
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "objectType": 1,
        "schema": {
          "id": "fjETFn",
          "title": "my chart",
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "objectType": 1
        },
        "cpuQuotients1": [
          12.3
        ],
        "cpuQuotients2": [
          12.3
        ],
        "responseTimeSeconds1": 12.3,
        "responseTimeSeconds2": 12.3
      }
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {}
    ],
    "dataModelSizeMiB": 654.6,
    "hasSectionAccess": false,
    "topFieldsByBytes": [
      {}
    ],
    "topTablesByBytes": [
      {}
    ],
    "objSingleThreaded": [
      {}
    ],
    "appOpenTimeSeconds": 12.3
  },
  "status": "finished",
  "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
  "appName": "my app",
  "details": {
    "errors": [
      "this is an error"
    ],
    "openApp": {
      "cpuSeconds": [
        12.3
      ],
      "cpuQuotients": [
        12.3
      ],
      "responseTimeSeconds": 234.3
    },
    "warnings": [
      "this is a warning"
    ],
    "dedicated": false,
    "fileSizeMiB": 12.3,
    "objectMetrics": {},
    "openAppCached": {
      "cpuSeconds": [
        12.3
      ],
      "cpuQuotients": [
        12.3
      ],
      "responseTimeSeconds": 234.3
    },
    "engineHasCache": false,
    "concurrentReload": false,
    "minMemoryFreeMiB": 12.3,
    "maxMemoryUsageMiB": 12.3,
    "physicalMemoryMiB": 12.3,
    "maxMemoryCachedMiB": 12.3,
    "maxMemoryNotFreeMiB": 12.3,
    "maxMemoryWorkingMiB": 12.3
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "spaceId": "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"
}

Retrieve a specific evaluation

Find an evaluation by a specific id.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Query Parameters

  • allboolean

    Get the full data of the evaluation

  • formatstring

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

Path Parameters

  • idstring
    Required

    Id of the desired evaluation.

Responses

200

application/json

Evaluation(s) retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • idstring
    • appIdstring
    • endedstring
    • eventsarray of objects
    • resultobject
      Show result properties
      • sheetsarray of objects
      • objHeavyarray of objects
      • rowCountnumber
      • objNoCachearray of objects
      • sheetCountnumber
      • fileSizeMiBnumber
      • objectCountnumber
      • maxMemoryMiBnumber
      • objSlowCachedarray of objects
      • documentSizeMiBnumber
      • objSlowUncachedarray of objects
      • dataModelSizeMiBnumber
      • hasSectionAccessboolean
      • topFieldsByBytesarray of objects
      • topTablesByBytesarray of objects
      • objSingleThreadedarray of objects
      • appOpenTimeSecondsnumber
    • statusstring
    • userIdstring
    • appNamestring
    • detailsobject
      Show details properties
      • errorsarray of strings
      • openAppobject
        Show openApp properties
        • cpuSecondsarray of numbers
        • cpuQuotientsarray of numbers
        • responseTimeSecondsnumber
      • warningsarray of strings
      • dedicatedboolean
      • fileSizeMiBnumber
      • objectMetricsobject
      • openAppCachedobject
        Show openAppCached properties
        • cpuSecondsarray of numbers
        • cpuQuotientsarray of numbers
        • responseTimeSecondsnumber
      • engineHasCacheboolean
      • concurrentReloadboolean
      • minMemoryFreeMiBnumber
      • maxMemoryUsageMiBnumber
      • physicalMemoryMiBnumber
      • maxMemoryCachedMiBnumber
      • maxMemoryNotFreeMiBnumber
      • maxMemoryWorkingMiBnumber
    • sheetIdstring
    • spaceIdstring
    • startedstring
    • versionnumber
    • metadataobject
      Show metadata properties
      • reloadmetaobject
        Show reloadmeta properties
        • cpuspentnumber
        • peakmemorybytesnumber
      • amountofrowsnumber
      • amountoffieldsnumber
      • amountoftablesnumber
      • staticbytesizenumber
      • hassectionaccessboolean
      • amountoffieldvaluesnumber
      • amountofcardinalfieldvaluesnumber
    • tenantIdstring
    • appItemIdstring
    • timestampstring
    • sheetTitlestring

404

application/json

Not Found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger
GET /v1/evaluations/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations/{id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/evaluations/{id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
qlik evaluation get <evaluationId>

Response

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {}
  ],
  "result": {
    "sheets": [
      {}
    ],
    "objHeavy": [
      {}
    ],
    "rowCount": 20000,
    "objNoCache": [
      {}
    ],
    "sheetCount": 5,
    "fileSizeMiB": 12.3,
    "objectCount": 33,
    "maxMemoryMiB": 12.3,
    "objSlowCached": [
      {}
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {}
    ],
    "dataModelSizeMiB": 654.6,
    "hasSectionAccess": false,
    "topFieldsByBytes": [
      {}
    ],
    "topTablesByBytes": [
      {}
    ],
    "objSingleThreaded": [
      {}
    ],
    "appOpenTimeSeconds": 12.3
  },
  "status": "finished",
  "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
  "appName": "my app",
  "details": {
    "errors": [
      "this is an error"
    ],
    "openApp": {
      "cpuSeconds": [
        12.3
      ],
      "cpuQuotients": [
        12.3
      ],
      "responseTimeSeconds": 234.3
    },
    "warnings": [
      "this is a warning"
    ],
    "dedicated": false,
    "fileSizeMiB": 12.3,
    "objectMetrics": {},
    "openAppCached": {
      "cpuSeconds": [
        12.3
      ],
      "cpuQuotients": [
        12.3
      ],
      "responseTimeSeconds": 234.3
    },
    "engineHasCache": false,
    "concurrentReload": false,
    "minMemoryFreeMiB": 12.3,
    "maxMemoryUsageMiB": 12.3,
    "physicalMemoryMiB": 12.3,
    "maxMemoryCachedMiB": 12.3,
    "maxMemoryNotFreeMiB": 12.3,
    "maxMemoryWorkingMiB": 12.3
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "spaceId": "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"
}

Download a detailed XML log of a specific evaluation

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

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Path Parameters

  • idstring
    Required

    Id of the desired evaluation.

Responses

200

application/xml

Evaluation(s) retrieved successfully.

  • application/xmlobject
    Show application/xml properties
    • idstring
    • appIdstring
    • endedstring
    • eventsarray of objects
    • resultobject
      Show result properties
      • sheetsarray of objects
      • objHeavyarray of objects
      • rowCountnumber
      • objNoCachearray of objects
      • sheetCountnumber
      • fileSizeMiBnumber
      • objectCountnumber
      • maxMemoryMiBnumber
      • objSlowCachedarray of objects
      • documentSizeMiBnumber
      • objSlowUncachedarray of objects
      • dataModelSizeMiBnumber
      • hasSectionAccessboolean
      • topFieldsByBytesarray of objects
      • topTablesByBytesarray of objects
      • objSingleThreadedarray of objects
      • appOpenTimeSecondsnumber
    • statusstring
    • userIdstring
    • appNamestring
    • detailsobject
      Show details properties
      • errorsarray of strings
      • openAppobject
        Show openApp properties
        • cpuSecondsarray of numbers
        • cpuQuotientsarray of numbers
        • responseTimeSecondsnumber
      • warningsarray of strings
      • dedicatedboolean
      • fileSizeMiBnumber
      • objectMetricsobject
      • openAppCachedobject
        Show openAppCached properties
        • cpuSecondsarray of numbers
        • cpuQuotientsarray of numbers
        • responseTimeSecondsnumber
      • engineHasCacheboolean
      • concurrentReloadboolean
      • minMemoryFreeMiBnumber
      • maxMemoryUsageMiBnumber
      • physicalMemoryMiBnumber
      • maxMemoryCachedMiBnumber
      • maxMemoryNotFreeMiBnumber
      • maxMemoryWorkingMiBnumber
    • sheetIdstring
    • spaceIdstring
    • startedstring
    • versionnumber
    • metadataobject
      Show metadata properties
      • reloadmetaobject
        Show reloadmeta properties
        • cpuspentnumber
        • peakmemorybytesnumber
      • amountofrowsnumber
      • amountoffieldsnumber
      • amountoftablesnumber
      • staticbytesizenumber
      • hassectionaccessboolean
      • amountoffieldvaluesnumber
      • amountofcardinalfieldvaluesnumber
    • tenantIdstring
    • appItemIdstring
    • timestampstring
    • sheetTitlestring

404

application/json

Not Found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • statusinteger
GET /v1/evaluations/{id}/download
curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations/{id}/download" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/evaluations/{id}/download',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
qlik evaluation download <evaluationId>

Response

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "ended": "2022-02-09T06:58:40.575Z",
  "events": [
    {}
  ],
  "result": {
    "sheets": [
      {}
    ],
    "objHeavy": [
      {}
    ],
    "rowCount": 20000,
    "objNoCache": [
      {}
    ],
    "sheetCount": 5,
    "fileSizeMiB": 12.3,
    "objectCount": 33,
    "maxMemoryMiB": 12.3,
    "objSlowCached": [
      {}
    ],
    "documentSizeMiB": 12.3,
    "objSlowUncached": [
      {}
    ],
    "dataModelSizeMiB": 654.6,
    "hasSectionAccess": false,
    "topFieldsByBytes": [
      {}
    ],
    "topTablesByBytes": [
      {}
    ],
    "objSingleThreaded": [
      {}
    ],
    "appOpenTimeSeconds": 12.3
  },
  "status": "finished",
  "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
  "appName": "my app",
  "details": {
    "errors": [
      "this is an error"
    ],
    "openApp": {
      "cpuSeconds": [
        12.3
      ],
      "cpuQuotients": [
        12.3
      ],
      "responseTimeSeconds": 234.3
    },
    "warnings": [
      "this is a warning"
    ],
    "dedicated": false,
    "fileSizeMiB": 12.3,
    "objectMetrics": {},
    "openAppCached": {
      "cpuSeconds": [
        12.3
      ],
      "cpuQuotients": [
        12.3
      ],
      "responseTimeSeconds": 234.3
    },
    "engineHasCache": false,
    "concurrentReload": false,
    "minMemoryFreeMiB": 12.3,
    "maxMemoryUsageMiB": 12.3,
    "physicalMemoryMiB": 12.3,
    "maxMemoryCachedMiB": 12.3,
    "maxMemoryNotFreeMiB": 12.3,
    "maxMemoryWorkingMiB": 12.3
  },
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "spaceId": "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"
}