Skip to content

evaluations

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

Endpoints

Skip to section
POST/evaluations
GET/evaluations
GET/evaluations/{id}

queue an app evaluation

Queues 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.

Request Bodyqueue an app evaluation

application/json

The parameters of the evaluation

Responsesqueue an app evaluation

201
application/json

App evaluation queued.

400
application/json

Bad request, incorrect body.

403
application/json

User lacks permissions to evaluate app.

500
application/json

Internal server error.

POST

/evaluations

curl "https://your-tenant.us.qlikcloud.com/api/v1/evaluations" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"itemid":"5e6f8cc63d33cc00018db30b","appid":"7c2ce11d-4d10-4414-a9b0-620e57298038"}'

Requestqueue an app evaluation

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

Responsequeue an app evaluation

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appName": "my app",
  "spaceId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "status": "finished",
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "sheetTitle": "my sheet",
  "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
  "events": [
    {
      "severity": "warning",
      "errorcode": "ERR-GOPHERCISER",
      "details": "An object failed",
      "objectid": "adfRFr",
      "objecttype": "linechart",
      "objectvisualization": "linechart",
      "objecttitle": "profit"
    }
  ],
  "result": {
    "maxmemorymib": 12.3,
    "documentsizemib": 12.3,
    "filesizemib": 12.3,
    "appopentimeseconds": 12.3,
    "objectcount": 33,
    "sheetcount": 5,
    "rowcount": 20000,
    "datamodelsizemib": 654.6,
    "hassectionaccess": true,
    "objnocache": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "responsetimeseconds1": 12.3,
        "responsetimeseconds2": 12.3
      }
    ],
    "objslowuncached": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "responsetimeseconds1": 12.3,
        "responsetimeseconds2": 12.3
      }
    ],
    "objslowcached": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "schema": {
          "id": "fjETFn",
          "objectType": 1,
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "title": "my chart"
        },
        "responsetimeseconds1": 12.3,
        "responsetimeseconds2": 12.3,
        "cpuquotients1": [],
        "cpuquotients2": []
      }
    ],
    "objsinglethreaded": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "cpuquotient1": 12.3,
        "cpuquotient2": 12.3,
        "cpuseconds1": 12.3,
        "cpuseconds2": 12.3
      }
    ],
    "objheavy": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "cpuquotient1": 12.3,
        "cpuquotient2": 12.3,
        "cpuseconds1": 12.3,
        "cpuseconds2": 12.3
      }
    ],
    "toptablesbybytes": [
      {
        "name": "some field/table",
        "is_system": true,
        "byte_size": 12873,
        "no_of_rows": 1234
      }
    ],
    "topfieldsbybytes": [
      {
        "name": "some field/table",
        "is_system": true,
        "byte_size": 12873,
        "total_count": 1234,
        "cardinal": 1112
      }
    ]
  },
  "metadata": {
    "staticbytesize": 1444234,
    "hassectionaccess": true,
    "amountoffields": 12,
    "amountoftables": 7,
    "amountofrows": 1423423234,
    "amountofcardinalfieldvalues": 14442,
    "amountoffieldvalues": 144423433,
    "reloadmeta": {
      "cpuspent": "123983",
      "peakmemorybytes": 112
    }
  },
  "details": {
    "warnings": [],
    "errors": [],
    "fileSizeMiB": 12.3,
    "maxMemoryCachedMiB": 12.3,
    "maxMemoryUsageMiB": 12.3,
    "maxMemoryWorkingMiB": 12.3,
    "minMemoryFreeMiB": 12.3,
    "maxMemoryNotFreeMiB": 12.3,
    "physicalMemoryMiB": 12.3,
    "openApp": {
      "responsetimeseconds": 234.3,
      "cpuseconds": [],
      "cpuquotients": []
    },
    "openAppCached": {
      "responsetimeseconds": 234.3,
      "cpuseconds": [],
      "cpuquotients": []
    },
    "objectMetrics": {},
    "engineHasCache": true,
    "dedicated": true,
    "concurrentReload": true
  }
}

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

Finds and returns 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

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

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

Number of results to return per page.

itemid
optional
string

The app item id.

appid
optional
string

The app guid.

next
optional
string

The app evaluation id to get next page from

prev
optional
string

The app evaluation id to get previous page from

all
optional
boolean

Get the full data of the evaluation

format
optional
string

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

filemode
optional
boolean

Add file transfer headers to response

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

200
application/json

Evaluation(s) retrieved successfully.

404
application/json

Not Found.

500
application/json

Internal server error.

GET

/evaluations

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

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

{
  "evaluations": [
    {
      "id": "5ecb5e65028d1f0001a98071",
      "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
      "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "appName": "my app",
      "spaceId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "status": "finished",
      "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
      "sheetTitle": "my sheet",
      "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
      "events": [
        {
          "severity": "warning",
          "errorcode": "ERR-GOPHERCISER",
          "details": "An object failed",
          "objectid": "adfRFr",
          "objecttype": "linechart",
          "objectvisualization": "linechart",
          "objecttitle": "profit"
        }
      ],
      "result": {
        "maxmemorymib": 12.3,
        "documentsizemib": 12.3,
        "filesizemib": 12.3,
        "appopentimeseconds": 12.3,
        "objectcount": 33,
        "sheetcount": 5,
        "rowcount": 20000,
        "datamodelsizemib": 654.6,
        "hassectionaccess": true,
        "objnocache": [
          {
            "id": "fjETFn",
            "objectType": 1,
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "title": "my chart",
            "responsetimeseconds1": 12.3,
            "responsetimeseconds2": 12.3
          }
        ],
        "objslowuncached": [
          {
            "id": "fjETFn",
            "objectType": 1,
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "title": "my chart",
            "responsetimeseconds1": 12.3,
            "responsetimeseconds2": 12.3
          }
        ],
        "objslowcached": [
          {
            "id": "fjETFn",
            "objectType": 1,
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "title": "my chart",
            "schema": {
              "id": "fjETFn",
              "objectType": 1,
              "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
              "title": "my chart"
            },
            "responsetimeseconds1": 12.3,
            "responsetimeseconds2": 12.3,
            "cpuquotients1": [],
            "cpuquotients2": []
          }
        ],
        "objsinglethreaded": [
          {
            "id": "fjETFn",
            "objectType": 1,
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "title": "my chart",
            "cpuquotient1": 12.3,
            "cpuquotient2": 12.3,
            "cpuseconds1": 12.3,
            "cpuseconds2": 12.3
          }
        ],
        "objheavy": [
          {
            "id": "fjETFn",
            "objectType": 1,
            "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
            "title": "my chart",
            "cpuquotient1": 12.3,
            "cpuquotient2": 12.3,
            "cpuseconds1": 12.3,
            "cpuseconds2": 12.3
          }
        ],
        "toptablesbybytes": [
          {
            "name": "some field/table",
            "is_system": true,
            "byte_size": 12873,
            "no_of_rows": 1234
          }
        ],
        "topfieldsbybytes": [
          {
            "name": "some field/table",
            "is_system": true,
            "byte_size": 12873,
            "total_count": 1234,
            "cardinal": 1112
          }
        ]
      },
      "metadata": {
        "staticbytesize": 1444234,
        "hassectionaccess": true,
        "amountoffields": 12,
        "amountoftables": 7,
        "amountofrows": 1423423234,
        "amountofcardinalfieldvalues": 14442,
        "amountoffieldvalues": 144423433,
        "reloadmeta": {
          "cpuspent": "123983",
          "peakmemorybytes": 112
        }
      },
      "details": {
        "warnings": [],
        "errors": [],
        "fileSizeMiB": 12.3,
        "maxMemoryCachedMiB": 12.3,
        "maxMemoryUsageMiB": 12.3,
        "maxMemoryWorkingMiB": 12.3,
        "minMemoryFreeMiB": 12.3,
        "maxMemoryNotFreeMiB": 12.3,
        "physicalMemoryMiB": 12.3,
        "openApp": {
          "responsetimeseconds": 234.3,
          "cpuseconds": [],
          "cpuquotients": []
        },
        "openAppCached": {
          "responsetimeseconds": 234.3,
          "cpuseconds": [],
          "cpuquotients": []
        },
        "objectMetrics": {},
        "engineHasCache": true,
        "dedicated": true,
        "concurrentReload": true
      }
    }
  ],
  "links": {
    "next": "/api/v1/evaluations/appid=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35"
  }
}

retrieves a specific evaluation

Finds and returns an evaluation by a specific id.

Path Parametersretrieves a specific evaluation

id
string

Id of the desired evaluation.

Query Parametersretrieves a specific evaluation

all
optional
boolean

Get the full data of the evaluation

format
optional
string

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

Responsesretrieves a specific evaluation

200
application/json

Evaluation(s) retrieved successfully.

404
application/json

Not Found.

500
application/json

Internal server error.

GET

/evaluations/{id}

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

Responseretrieves a specific evaluation

{
  "id": "5ecb5e65028d1f0001a98071",
  "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038",
  "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "appName": "my app",
  "spaceId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "status": "finished",
  "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "sheetId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn",
  "sheetTitle": "my sheet",
  "userId": "CGMCdm9v4kuTdfimNMacdnsaFI9njcmB",
  "events": [
    {
      "severity": "warning",
      "errorcode": "ERR-GOPHERCISER",
      "details": "An object failed",
      "objectid": "adfRFr",
      "objecttype": "linechart",
      "objectvisualization": "linechart",
      "objecttitle": "profit"
    }
  ],
  "result": {
    "maxmemorymib": 12.3,
    "documentsizemib": 12.3,
    "filesizemib": 12.3,
    "appopentimeseconds": 12.3,
    "objectcount": 33,
    "sheetcount": 5,
    "rowcount": 20000,
    "datamodelsizemib": 654.6,
    "hassectionaccess": true,
    "objnocache": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "responsetimeseconds1": 12.3,
        "responsetimeseconds2": 12.3
      }
    ],
    "objslowuncached": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "responsetimeseconds1": 12.3,
        "responsetimeseconds2": 12.3
      }
    ],
    "objslowcached": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "schema": {
          "id": "fjETFn",
          "objectType": 1,
          "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
          "title": "my chart"
        },
        "responsetimeseconds1": 12.3,
        "responsetimeseconds2": 12.3,
        "cpuquotients1": [],
        "cpuquotients2": []
      }
    ],
    "objsinglethreaded": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "cpuquotient1": 12.3,
        "cpuquotient2": 12.3,
        "cpuseconds1": 12.3,
        "cpuseconds2": 12.3
      }
    ],
    "objheavy": [
      {
        "id": "fjETFn",
        "objectType": 1,
        "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b",
        "title": "my chart",
        "cpuquotient1": 12.3,
        "cpuquotient2": 12.3,
        "cpuseconds1": 12.3,
        "cpuseconds2": 12.3
      }
    ],
    "toptablesbybytes": [
      {
        "name": "some field/table",
        "is_system": true,
        "byte_size": 12873,
        "no_of_rows": 1234
      }
    ],
    "topfieldsbybytes": [
      {
        "name": "some field/table",
        "is_system": true,
        "byte_size": 12873,
        "total_count": 1234,
        "cardinal": 1112
      }
    ]
  },
  "metadata": {
    "staticbytesize": 1444234,
    "hassectionaccess": true,
    "amountoffields": 12,
    "amountoftables": 7,
    "amountofrows": 1423423234,
    "amountofcardinalfieldvalues": 14442,
    "amountoffieldvalues": 144423433,
    "reloadmeta": {
      "cpuspent": "123983",
      "peakmemorybytes": 112
    }
  },
  "details": {
    "warnings": [],
    "errors": [],
    "fileSizeMiB": 12.3,
    "maxMemoryCachedMiB": 12.3,
    "maxMemoryUsageMiB": 12.3,
    "maxMemoryWorkingMiB": 12.3,
    "minMemoryFreeMiB": 12.3,
    "maxMemoryNotFreeMiB": 12.3,
    "physicalMemoryMiB": 12.3,
    "openApp": {
      "responsetimeseconds": 234.3,
      "cpuseconds": [],
      "cpuquotients": []
    },
    "openAppCached": {
      "responsetimeseconds": 234.3,
      "cpuseconds": [],
      "cpuquotients": []
    },
    "objectMetrics": {},
    "engineHasCache": true,
    "dedicated": true,
    "concurrentReload": true
  }
}

PostBody

object

PropertiesPostBody

itemid
string

The item id of the app in collection service

appid
string

The app guid of the app

Error

object

PropertiesError

errors

No description

defaultResponse

object

PropertiesdefaultResponse

code
string<integer>

No description

message
string<string>

No description

evaluation

object

Propertiesevaluation

id
string<string>

No description

appId
string<string>

No description

appItemId
string<string>

No description

appName
string<string>

No description

spaceId
string<string>

No description

status
string<string>

No description

tenantId
string<string>

No description

sheetId
string<string>

No description

sheetTitle
string<string>

No description

userId
string<string>

No description

events

No description

result

No description

metadata

No description

details

No description

event

object

Propertiesevent

severity
string

No description

errorcode
string

No description

details
string

No description

objectid
string

No description

objecttype
string

No description

objectvisualization
string

No description

objecttitle
string

No description

evaluations

object

Propertiesevaluations

evaluations

No description

links

No description

objectmetrics

object

Propertiesobjectmetrics

responsetimeseconds
number

No description

cpuseconds
Array<number>

No description

cpuquotients
Array<number>

No description

objectspec

object

Propertiesobjectspec

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

objecttopspec

object

Propertiesobjecttopspec

name
string<string>

No description

is_system
boolean

No description

byte_size
number

No description

resultentry

Propertiesresultentry

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

passes

No description

result

object

Propertiesresult

maxmemorymib
number

No description

documentsizemib
number

No description

filesizemib
number

No description

appopentimeseconds
number

No description

objectcount
number

No description

sheetcount
number

No description

rowcount
number

No description

datamodelsizemib
number

No description

hassectionaccess
boolean

No description

objnocache

No description

objslowuncached

No description

objslowcached

No description

objsinglethreaded

No description

objheavy

No description

toptablesbybytes

No description

topfieldsbybytes

No description

resultobjresponsetime

Propertiesresultobjresponsetime

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

responsetimeseconds1
number

No description

responsetimeseconds2
number

No description

resultobjheavy

Propertiesresultobjheavy

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

cpuquotient1
number

No description

cpuquotient2
number

No description

cpuseconds1
number

No description

cpuseconds2
number

No description

resultobjsinglethreaded

Propertiesresultobjsinglethreaded

id
string<string>

No description

objectType
number

No description

sheetId
string<string>

No description

title
string<string>

No description

schema

No description

responsetimeseconds1
number

No description

responsetimeseconds2
number

No description

cpuquotients1
array

No description

cpuquotients2
array

No description

resultmetadatatoptables

Propertiesresultmetadatatoptables

name
string<string>

No description

is_system
boolean

No description

byte_size
number

No description

no_of_rows
number

No description

resultmetadatatopfields

Propertiesresultmetadatatopfields

name
string<string>

No description

is_system
boolean

No description

byte_size
number

No description

total_count
number

No description

cardinal
number

No description

metadata

object

Propertiesmetadata

staticbytesize
number

No description

hassectionaccess
boolean

No description

amountoffields
number

No description

amountoftables
number

No description

amountofrows
number

No description

amountofcardinalfieldvalues
number

No description

amountoffieldvalues
number

No description

reloadmeta

No description

v1.2.0
Was this page helpful?