Endpoints
Restores a soft-deleted Qlik Cloud Analytics application to the same space with the same app ID, retaining the properties it had at the time of deletion. This operation is available to the app owner and Tenant Admins. The app owner can restore the app only if the original space still exists and they still have delete permission in the space; otherwise, a 403 Forbidden error is returned. Associated resources such as data alerts, subscriptions, collections, notes, and tags are deleted when the app is deleted and cannot be restored.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Path Parameters
- appId stringRequired
Identifier of the app.
Responses
200
OK
- application/json object
Application attributes and user privileges.
application/json properties
- create array of objects
Object create privileges. Hints to the client what type of objects the user is allowed to create.
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
Application attributes.
attributes properties
- id string
The App ID.
- name string
App name.
- state string
Promotion state of the app. Promotion state of an app. One of:
- EMPTY
- PROMOTED
- DISTRIBUTED
Can be one of: "EMPTY""PROMOTED""DISTRIBUTED"
- usage string
Indicates the use for the app.
One of:
- ANALYTICS
- DATA_PREPARATION
- DATAFLOW_PREP
- SINGLE_TABLE_PREP
- DIRECT_QUERY_MODE
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
- ownerId string
Identifier of the app owner.
- spaceId string
The ID of the app's space.
- createdAt string
The date and time when the app was created.
- updatedAt string
The date and time when the app was modified.
- promotedAt string
The date and time when the app was promoted, empty if not promoted. Use to determine if an app is promoted in Qlik Cloud.
- reloadedAt string
Date and time of the last reload of the app.
- description string
App description.
- originAppId string
The Origin App ID for promoted apps.
- resourceType string
App resource type.
- hasSectionAccess boolean
If set to true, the app has section access configured.
-
- 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
-
400
Bad Request
- application/json object
application/json properties
- errors array of objects
Array of all errors that occurred during the request.
errors properties
- code stringRequired
A unique code for the error.
- title stringRequired
A human-readable description of the error.
- detail string
Additional information about the error.
-
-
401
Unauthorized
- application/json object
application/json properties
- errors array of objects
Array of all errors that occurred during the request.
errors properties
- code stringRequired
A unique code for the error.
- title stringRequired
A human-readable description of the error.
- detail string
Additional information about the error.
-
-
403
Forbidden
- application/json object
application/json properties
- errors array of objects
Array of all errors that occurred during the request.
errors properties
- code stringRequired
A unique code for the error.
- title stringRequired
A human-readable description of the error.
- detail string
Additional information about the error.
-
-
404
Not Found
- application/json object
application/json properties
- errors array of objects
Array of all errors that occurred during the request.
errors properties
- code stringRequired
A unique code for the error.
- title stringRequired
A human-readable description of the error.
- detail string
Additional information about the error.
-
-
POST /api /analytics /apps /{appId} /actions /restore
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.apps.restoreApp('string')qlik analytics app restore 'string'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/apps/{appId}/actions/restore" \-X POST \-H "Authorization: Bearer <access_token>"Example Response
{ "create": [ { "resource": "string", "canCreate": true } ], "attributes": { "id": "string", "name": "string", "state": "string", "usage": "string", "ownerId": "string", "spaceId": "string", "createdAt": "2019-01-01T00:00:00.000Z", "updatedAt": "2019-01-01T00:00:00.000Z", "promotedAt": "2019-01-01T00:00:00.000Z", "reloadedAt": "2019-01-01T00:00:00.000Z", "description": "string", "originAppId": "string", "resourceType": "string", "hasSectionAccess": true }, "privileges": [ "string" ]}Returns a paginated list of historical evaluations for the specified app. Use
the next and prev cursor values from the response links to navigate through
pages of results.
Facts
| Rate limit | Tier 1 (1000 requests per minute) | |
| Replaces |
Query Parameters
- all boolean
When
true, includes full evaluation details in each result. Whenfalse, detail fields are omitted. - fileMode boolean
When
true, adds file download headers to the response. - format string
The output format for the response. Accepts
jsonorxml. - limit integer
Maximum number of results to return per page.
- next string
A cursor token for fetching the next page of results.
- prev string
A cursor token for fetching the previous page of results.
- sort string
The field to sort results by. Prefix with
-for descending order or+for ascending.Can be one of: "started""+started""-started"
Path Parameters
- guid stringRequired
The unique identifier of the app.
Responses
200
App evaluations retrieved successfully.
- application/json object
application/json properties
- data array of objects
data properties
- id string
- appId string
- ended string
- engine object
engine properties
- shortName string
-
- events array of objects
events properties
- message string
- sheetId string
- objectId string
- severity string
- errorCode string
- objectType string
- sheetTitle string
- objectTitle string
- objectVisualization string
-
- result object
result properties
- openApp object
openApp properties
- steps array of objects
steps properties
- name string
- durationMilliseconds number
-
- totalDurationMilliseconds number
-
- rowCount number
- objNoCache array of objects
objNoCache properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- sheetCount number
- objectCount number
- sheetsCached array of objects
sheetsCached properties
- sheet object
sheet properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objectCount number
- sheetObjects array of objects
sheetObjects properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
-
- objSlowCached array of objects
objSlowCached properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objMemoryLimit array of objects
objMemoryLimit properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- memoryLimitStatusCode string
-
- sheetsUncached array of objects
sheetsUncached properties
- sheet object
sheet properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objectCount number
- sheetObjects array of objects
sheetObjects properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
-
- documentSizeMiB number
- objSlowUncached array of objects
objSlowUncached properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- hasSectionAccess boolean
- topFieldsByBytes array of objects
topFieldsByBytes properties
- name string
- byteSize number
- isSystem boolean
-
- topTablesByBytes array of objects
topTablesByBytes properties
- name string
- byteSize number
- isSystem boolean
-
- objSingleThreaded array of objects
objSingleThreaded properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- cpuQuotients array of numbers
- responseTimeSeconds number
-
-
- status string
- appName string
- details object
details properties
- errors array of strings
- warnings array of strings
- objectMetrics object
additional optional properties
- object object
object properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- passes array of objects
passes properties
- errorCode string
- cpuSeconds array of numbers
- cpuQuotients array of numbers
- responseTimeSeconds number
-
-
-
- engineHasCache boolean
- concurrentReload boolean
-
- started string
- version number
- tenantId string
- appItemId string
- timestamp string
- openAppProgress object
openAppProgress properties
- messages array of objects
messages properties
- message string
- timeSinceStartMilliseconds string
-
-
- reloadInformation object
reloadInformation properties
- reloadmeta object
reloadmeta properties
- cpuspent number
- peakmemorybytes number
-
- amountofrows number
- amountoffields number
- amountoftables number
- staticbytesize number
- hassectionaccess boolean
- amountoffieldvalues number
- amountofcardinalfieldvalues number
-
-
- links object
links properties
- next object
next properties
- href string
-
- prev object
prev properties
- href string
-
-
-
400
Bad request. The request contains invalid or missing parameters.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
403
Access denied. You lack the required permissions to list evaluations for this app.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
404
The specified app was not found.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
500
Internal server error.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
GET /api /analytics /apps /{guid} /evaluations
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.apps.getAppEvaluations( 'abcdefghijklmnopq', {},)qlik analytics app evaluation ls \ --appId 'abcdefghijklmnopq'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/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", "engine": { "shortName": "OAPE-40" }, "events": [ { "message": "An object failed", "sheetId": "gregFG", "objectId": "adfRFr", "severity": "warning", "errorCode": "ERR-GOPHERCISER", "objectType": "linechart", "sheetTitle": "mysheet", "objectTitle": "profit", "objectVisualization": "linechart" } ], "result": { "openApp": { "steps": [ { "name": "loadingFields", "durationMilliseconds": 1234 } ], "totalDurationMilliseconds": 12345 }, "rowCount": 20000, "objNoCache": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "sheetCount": 5, "objectCount": 33, "sheetsCached": [ { "sheet": { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 }, "objectCount": 1, "sheetObjects": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ] } ], "objSlowCached": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "objMemoryLimit": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "memoryLimitStatusCode": "OUT-OF-MEMORY" } ], "sheetsUncached": [ { "sheet": { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 }, "objectCount": 1, "sheetObjects": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ] } ], "documentSizeMiB": 12.3, "objSlowUncached": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "hasSectionAccess": false, "topFieldsByBytes": [ { "name": "some field/table", "byteSize": 12873, "isSystem": false } ], "topTablesByBytes": [ { "name": "some field/table", "byteSize": 12873, "isSystem": false } ], "objSingleThreaded": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "cpuQuotients": [ 12.3 ], "responseTimeSeconds": 12.3 } ] }, "status": "finished", "appName": "my app", "details": { "errors": [ "this is an error" ], "warnings": [ "this is a warning" ], "objectMetrics": {}, "engineHasCache": false, "concurrentReload": false }, "started": "2022-02-09T06:58:40.575Z", "version": 1, "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn", "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn", "timestamp": "2022-02-09T06:58:40.575Z", "openAppProgress": { "messages": [ { "message": "TODO", "timeSinceStartMilliseconds": "TODO" } ] }, "reloadInformation": { "reloadmeta": { "cpuspent": "123983", "peakmemorybytes": 112 }, "amountofrows": 1423423234, "amountoffields": 12, "amountoftables": 7, "staticbytesize": 1444234, "hassectionaccess": false, "amountoffieldvalues": 144423433, "amountofcardinalfieldvalues": 14442 } } ], "links": { "next": { "href": "/analytics/apps/evaluations/appId=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35" }, "prev": { "href": "/analytics/apps/evaluations/appId=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35" } }}Queues a performance and scalability evaluation for the specified app, scheduling
it for execution by the evaluation engine. The evaluation measures object response
times, CPU usage, document size, and data model metrics. Once queued, use the
returned id with the retrieval operations to poll for results.
Facts
| Rate limit | Tier 2 (100 requests per minute) | |
| Replaces |
Path Parameters
- guid stringRequired
The unique identifier of the app to evaluate.
Request Body
Optional evaluation settings. The body may be omitted entirely.
- application/json object
application/json properties
- engineSizeHint string
Overrides the automatic engine size calculation with the supplied number of GiB. The value is forwarded to the engine session request when acquiring an engine. Optional.
-
Responses
201
App evaluation queued successfully.
- application/json object
application/json properties
- id string
- appId string
- ended string
- engine object
engine properties
- shortName string
-
- events array of objects
events properties
- message string
- sheetId string
- objectId string
- severity string
- errorCode string
- objectType string
- sheetTitle string
- objectTitle string
- objectVisualization string
-
- result object
result properties
- openApp object
openApp properties
- steps array of objects
steps properties
- name string
- durationMilliseconds number
-
- totalDurationMilliseconds number
-
- rowCount number
- objNoCache array of objects
objNoCache properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- sheetCount number
- objectCount number
- sheetsCached array of objects
sheetsCached properties
- sheet object
sheet properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objectCount number
- sheetObjects array of objects
sheetObjects properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
-
- objSlowCached array of objects
objSlowCached properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objMemoryLimit array of objects
objMemoryLimit properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- memoryLimitStatusCode string
-
- sheetsUncached array of objects
sheetsUncached properties
- sheet object
sheet properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objectCount number
- sheetObjects array of objects
sheetObjects properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
-
- documentSizeMiB number
- objSlowUncached array of objects
objSlowUncached properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- hasSectionAccess boolean
- topFieldsByBytes array of objects
topFieldsByBytes properties
- name string
- byteSize number
- isSystem boolean
-
- topTablesByBytes array of objects
topTablesByBytes properties
- name string
- byteSize number
- isSystem boolean
-
- objSingleThreaded array of objects
objSingleThreaded properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- cpuQuotients array of numbers
- responseTimeSeconds number
-
-
- status string
- appName string
- details object
details properties
- errors array of strings
- warnings array of strings
- objectMetrics object
additional optional properties
- object object
object properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- passes array of objects
passes properties
- errorCode string
- cpuSeconds array of numbers
- cpuQuotients array of numbers
- responseTimeSeconds number
-
-
-
- engineHasCache boolean
- concurrentReload boolean
-
- started string
- version number
- tenantId string
- appItemId string
- timestamp string
- openAppProgress object
openAppProgress properties
- messages array of objects
messages properties
- message string
- timeSinceStartMilliseconds string
-
-
- reloadInformation object
reloadInformation properties
- reloadmeta object
reloadmeta properties
- cpuspent number
- peakmemorybytes number
-
- amountofrows number
- amountoffields number
- amountoftables number
- staticbytesize number
- hassectionaccess boolean
- amountoffieldvalues number
- amountofcardinalfieldvalues number
-
-
400
Bad request. The app identifier is missing or invalid.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
403
Access denied. You lack the required permissions to evaluate the app.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
404
The specified app was not found.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
429
The rate limit has been exceeded.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
500
Internal server error.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
POST /api /analytics /apps /{guid} /evaluations
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.apps.createAppEvaluation( 'abcdefghijklmnopq',)qlik analytics app evaluation create \ --appId 'abcdefghijklmnopq'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/apps/{guid}/evaluations" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"engineSizeHint":"80"}'Example Response
{ "id": "5ecb5e65028d1f0001a98071", "appId": "7c2ce11d-4d10-4414-a9b0-620e57298038", "ended": "2022-02-09T06:58:40.575Z", "engine": { "shortName": "OAPE-40" }, "events": [ { "message": "An object failed", "sheetId": "gregFG", "objectId": "adfRFr", "severity": "warning", "errorCode": "ERR-GOPHERCISER", "objectType": "linechart", "sheetTitle": "mysheet", "objectTitle": "profit", "objectVisualization": "linechart" } ], "result": { "openApp": { "steps": [ { "name": "loadingFields", "durationMilliseconds": 1234 } ], "totalDurationMilliseconds": 12345 }, "rowCount": 20000, "objNoCache": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "sheetCount": 5, "objectCount": 33, "sheetsCached": [ { "sheet": { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 }, "objectCount": 1, "sheetObjects": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ] } ], "objSlowCached": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "objMemoryLimit": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "memoryLimitStatusCode": "OUT-OF-MEMORY" } ], "sheetsUncached": [ { "sheet": { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 }, "objectCount": 1, "sheetObjects": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ] } ], "documentSizeMiB": 12.3, "objSlowUncached": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "hasSectionAccess": false, "topFieldsByBytes": [ { "name": "some field/table", "byteSize": 12873, "isSystem": false } ], "topTablesByBytes": [ { "name": "some field/table", "byteSize": 12873, "isSystem": false } ], "objSingleThreaded": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "cpuQuotients": [ 12.3 ], "responseTimeSeconds": 12.3 } ] }, "status": "finished", "appName": "my app", "details": { "errors": [ "this is an error" ], "warnings": [ "this is a warning" ], "objectMetrics": {}, "engineHasCache": false, "concurrentReload": false }, "started": "2022-02-09T06:58:40.575Z", "version": 1, "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn", "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn", "timestamp": "2022-02-09T06:58:40.575Z", "openAppProgress": { "messages": [ { "message": "TODO", "timeSinceStartMilliseconds": "TODO" } ] }, "reloadInformation": { "reloadmeta": { "cpuspent": "123983", "peakmemorybytes": 112 }, "amountofrows": 1423423234, "amountoffields": 12, "amountoftables": 7, "staticbytesize": 1444234, "hassectionaccess": false, "amountoffieldvalues": 144423433, "amountofcardinalfieldvalues": 14442 }}Compares exactly two app evaluations, a baseline and a comparison, returning a structured diff of performance metrics between them. Use this operation to detect regressions after app changes or engine upgrades. Both evaluations must belong to the same app.
Facts
| Rate limit | Tier 1 (1000 requests per minute) | |
| Replaces |
Query Parameters
- all boolean
When
true, includes all comparison entries regardless of significance. - format string
The output format for the response. Accepts
jsonorxml.
Path Parameters
- baselineId stringRequired
The unique identifier of the baseline app evaluation.
- comparisonId stringRequired
The unique identifier of the comparison app evaluation.
Responses
200
Comparison completed successfully.
- application/json object
application/json properties
- engine object
engine properties
- changed boolean
- baseline object
baseline properties
- shortName string
-
- comparison object
comparison properties
- shortName string
-
-
- rowCount object
rowCount properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- objNoCache object
objNoCache properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- sheetCount object
sheetCount properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- objectCount object
objectCount properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- sheetsCached object
sheetsCached properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- objSlowCached object
objSlowCached properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- objMemoryLimit array of objects
objMemoryLimit properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- baselineMemoryLimitStatusCode string
- comparisonMemoryLimitStatusCode string
-
- sheetsUncached object
sheetsUncached properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- documentSizeMiB object
documentSizeMiB properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- objSlowUncached object
objSlowUncached properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- hasSectionAccess object
hasSectionAccess properties
- diff number
- trend string
- absoluteDiff number
- baseline boolean
- comparison boolean
-
- topFieldsByBytes object
topFieldsByBytes properties
- list array of objects
list properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount 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
absoluteDiffAsc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount 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
relativeDiffAsc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount 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
absoluteDiffDesc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount 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
relativeDiffDesc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
-
-
- topTablesByBytes object
topTablesByBytes properties
- list array of objects
list properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows 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
absoluteDiffAsc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows 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
relativeDiffAsc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows 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
absoluteDiffDesc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows 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
relativeDiffDesc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
-
-
- objSingleThreaded object
objSingleThreaded properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
-
404
One or both of the specified app evaluations were not found.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
500
Internal server error.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
GET /api /analytics /apps /evaluations /{baselineId} /compare /{comparisonId}
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.apps.getAppEvaluationComparison( 'abcdefghijklmnopq', 'abcdefghijklmnopq', {},)qlik analytics app evaluation compare get 'abcdefghijklmnopq' \ --evaluationId 'abcdefghijklmnopq'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/apps/evaluations/{baselineId}/compare/{comparisonId}" \-H "Authorization: Bearer <access_token>"Example Response
{ "engine": { "changed": false, "baseline": { "shortName": "OAPE-40" }, "comparison": { "shortName": "OAPE-40" } }, "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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 }, "objectCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "sheetsCached": { "list": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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" } } ] }, "hasSectionAccess": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": false, "comparison": true }, "topFieldsByBytes": { "list": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "absoluteDiffAsc": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "relativeDiffAsc": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "absoluteDiffDesc": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "dataSourceStatus": "full", "relativeDiffDesc": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ] }, "topTablesByBytes": { "list": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "absoluteDiffAsc": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "relativeDiffAsc": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "absoluteDiffDesc": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "dataSourceStatus": "full", "relativeDiffDesc": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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" } } ] }}Downloads a comparison log for the two specified app evaluations (baseline and comparison),
defaulting to XML format. Use the Accept header to request JSON output instead.
Both evaluations must belong to the same app.
Facts
| Rate limit | Tier 1 (1000 requests per minute) | |
| Replaces |
Header Parameters
- Accept string
The desired response format. Accepts
application/xml(default) orapplication/json.Can be one of: "application/xml""application/json"
Path Parameters
- baselineId stringRequired
The unique identifier of the baseline app evaluation.
- comparisonId stringRequired
The unique identifier of the comparison app evaluation.
Responses
200
Comparison log retrieved successfully.
- application/json object
application/json properties
- engine object
engine properties
- changed boolean
- baseline object
baseline properties
- shortName string
-
- comparison object
comparison properties
- shortName string
-
-
- rowCount object
rowCount properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- objNoCache object
objNoCache properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- sheetCount object
sheetCount properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- objectCount object
objectCount properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- sheetsCached object
sheetsCached properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- objSlowCached object
objSlowCached properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- objMemoryLimit array of objects
objMemoryLimit properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- baselineMemoryLimitStatusCode string
- comparisonMemoryLimitStatusCode string
-
- sheetsUncached object
sheetsUncached properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- documentSizeMiB object
documentSizeMiB properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- objSlowUncached object
objSlowUncached properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
- hasSectionAccess object
hasSectionAccess properties
- diff number
- trend string
- absoluteDiff number
- baseline boolean
- comparison boolean
-
- topFieldsByBytes object
topFieldsByBytes properties
- list array of objects
list properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount 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
absoluteDiffAsc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount 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
relativeDiffAsc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount 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
absoluteDiffDesc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount 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
relativeDiffDesc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- cardinal object
cardinal properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- totalCount object
totalCount properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
-
-
- topTablesByBytes object
topTablesByBytes properties
- list array of objects
list properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows 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
absoluteDiffAsc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows 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
relativeDiffAsc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows 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
absoluteDiffDesc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows 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
relativeDiffDesc properties
- name string
- byteSize object
byteSize properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- isSystem boolean
- noOfRows object
noOfRows properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
-
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
-
-
- objSingleThreaded object
objSingleThreaded properties
- list array of objects
list properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffAsc array of objects
absoluteDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- relativeDiffAsc array of objects
relativeDiffAsc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
- absoluteDiffDesc array of objects
absoluteDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
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
relativeDiffDesc properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- dataSourceStatus string
Can be one of: "full""none""baselinemissing""comparisonmissing"
- responseTimeSeconds1 object
responseTimeSeconds1 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
- responseTimeSeconds2 object
responseTimeSeconds2 properties
- diff number
- trend string
- absoluteDiff number
- baseline number
- comparison number
- baselineTimeoutStatusCode string
- comparisonTimeoutStatusCode string
-
-
-
-
404
One or both of the specified app evaluations were not found.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
500
Internal server error.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
GET /api /analytics /apps /evaluations /{baselineId} /compare /{comparisonId} /actions /download
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.apps.getAppEvaluationComparisonXml( 'abcdefghijklmnopq', 'abcdefghijklmnopq',)qlik analytics app evaluation compare download \ --evaluationId 'abcdefghijklmnopq' \ --compareId 'abcdefghijklmnopq'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/apps/evaluations/{baselineId}/compare/{comparisonId}/actions/download" \-H "Authorization: Bearer <access_token>"Example Response
{ "engine": { "changed": false, "baseline": { "shortName": "OAPE-40" }, "comparison": { "shortName": "OAPE-40" } }, "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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 }, "objectCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "sheetsCached": { "list": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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" } } ] }, "hasSectionAccess": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": false, "comparison": true }, "topFieldsByBytes": { "list": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "absoluteDiffAsc": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "relativeDiffAsc": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "absoluteDiffDesc": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "dataSourceStatus": "full", "relativeDiffDesc": [ { "name": "a field name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "cardinal": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "totalCount": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ] }, "topTablesByBytes": { "list": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "absoluteDiffAsc": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "relativeDiffAsc": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "absoluteDiffDesc": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "dataSourceStatus": "full" } ], "dataSourceStatus": "full", "relativeDiffDesc": [ { "name": "a table name", "byteSize": { "diff": 0.5, "trend": "up", "absoluteDiff": 2.5, "baseline": 1, "comparison": 2 }, "isSystem": false, "noOfRows": { "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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", "sheetTitle": "my sheet", "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" } } ] }}Retrieves a single app evaluation by its unique identifier. Use the all parameter
to include full evaluation details in the response.
Facts
| Rate limit | Tier 1 (1000 requests per minute) | |
| Replaces |
Query Parameters
- all boolean
When
true, includes full app evaluation details in the response. - format string
The output format for the response. Accepts
jsonorxml.
Path Parameters
- id stringRequired
The unique identifier of the app evaluation to retrieve.
Responses
200
App evaluation retrieved successfully.
- application/json object
application/json properties
- id string
- appId string
- ended string
- engine object
engine properties
- shortName string
-
- events array of objects
events properties
- message string
- sheetId string
- objectId string
- severity string
- errorCode string
- objectType string
- sheetTitle string
- objectTitle string
- objectVisualization string
-
- result object
result properties
- openApp object
openApp properties
- steps array of objects
steps properties
- name string
- durationMilliseconds number
-
- totalDurationMilliseconds number
-
- rowCount number
- objNoCache array of objects
objNoCache properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- sheetCount number
- objectCount number
- sheetsCached array of objects
sheetsCached properties
- sheet object
sheet properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objectCount number
- sheetObjects array of objects
sheetObjects properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
-
- objSlowCached array of objects
objSlowCached properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objMemoryLimit array of objects
objMemoryLimit properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- memoryLimitStatusCode string
-
- sheetsUncached array of objects
sheetsUncached properties
- sheet object
sheet properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objectCount number
- sheetObjects array of objects
sheetObjects properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
-
- documentSizeMiB number
- objSlowUncached array of objects
objSlowUncached properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- hasSectionAccess boolean
- topFieldsByBytes array of objects
topFieldsByBytes properties
- name string
- byteSize number
- isSystem boolean
-
- topTablesByBytes array of objects
topTablesByBytes properties
- name string
- byteSize number
- isSystem boolean
-
- objSingleThreaded array of objects
objSingleThreaded properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- cpuQuotients array of numbers
- responseTimeSeconds number
-
-
- status string
- appName string
- details object
details properties
- errors array of strings
- warnings array of strings
- objectMetrics object
additional optional properties
- object object
object properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- passes array of objects
passes properties
- errorCode string
- cpuSeconds array of numbers
- cpuQuotients array of numbers
- responseTimeSeconds number
-
-
-
- engineHasCache boolean
- concurrentReload boolean
-
- started string
- version number
- tenantId string
- appItemId string
- timestamp string
- openAppProgress object
openAppProgress properties
- messages array of objects
messages properties
- message string
- timeSinceStartMilliseconds string
-
-
- reloadInformation object
reloadInformation properties
- reloadmeta object
reloadmeta properties
- cpuspent number
- peakmemorybytes number
-
- amountofrows number
- amountoffields number
- amountoftables number
- staticbytesize number
- hassectionaccess boolean
- amountoffieldvalues number
- amountofcardinalfieldvalues number
-
-
404
The specified app evaluation was not found.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
500
Internal server error.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
GET /api /analytics /apps /evaluations /{id}
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.apps.getAppEvaluation( 'abcdefghijklmnopq', {},)qlik analytics app evaluation get 'abcdefghijklmnopq'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/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", "engine": { "shortName": "OAPE-40" }, "events": [ { "message": "An object failed", "sheetId": "gregFG", "objectId": "adfRFr", "severity": "warning", "errorCode": "ERR-GOPHERCISER", "objectType": "linechart", "sheetTitle": "mysheet", "objectTitle": "profit", "objectVisualization": "linechart" } ], "result": { "openApp": { "steps": [ { "name": "loadingFields", "durationMilliseconds": 1234 } ], "totalDurationMilliseconds": 12345 }, "rowCount": 20000, "objNoCache": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "sheetCount": 5, "objectCount": 33, "sheetsCached": [ { "sheet": { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 }, "objectCount": 1, "sheetObjects": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ] } ], "objSlowCached": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "objMemoryLimit": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "memoryLimitStatusCode": "OUT-OF-MEMORY" } ], "sheetsUncached": [ { "sheet": { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 }, "objectCount": 1, "sheetObjects": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ] } ], "documentSizeMiB": 12.3, "objSlowUncached": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "hasSectionAccess": false, "topFieldsByBytes": [ { "name": "some field/table", "byteSize": 12873, "isSystem": false } ], "topTablesByBytes": [ { "name": "some field/table", "byteSize": 12873, "isSystem": false } ], "objSingleThreaded": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "cpuQuotients": [ 12.3 ], "responseTimeSeconds": 12.3 } ] }, "status": "finished", "appName": "my app", "details": { "errors": [ "this is an error" ], "warnings": [ "this is a warning" ], "objectMetrics": {}, "engineHasCache": false, "concurrentReload": false }, "started": "2022-02-09T06:58:40.575Z", "version": 1, "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn", "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn", "timestamp": "2022-02-09T06:58:40.575Z", "openAppProgress": { "messages": [ { "message": "TODO", "timeSinceStartMilliseconds": "TODO" } ] }, "reloadInformation": { "reloadmeta": { "cpuspent": "123983", "peakmemorybytes": 112 }, "amountofrows": 1423423234, "amountoffields": 12, "amountoftables": 7, "staticbytesize": 1444234, "hassectionaccess": false, "amountoffieldvalues": 144423433, "amountofcardinalfieldvalues": 14442 }}Downloads the evaluation log for the specified app evaluation, defaulting to XML
format. Use the Accept header to request JSON output instead.
Facts
| Rate limit | Tier 1 (1000 requests per minute) | |
| Replaces |
Header Parameters
- Accept string
The desired response format. Accepts
application/xml(default) orapplication/json.Can be one of: "application/xml""application/json"
Path Parameters
- id stringRequired
The unique identifier of the app evaluation to download.
Responses
200
App evaluation log retrieved successfully.
- application/json object
application/json properties
- id string
- appId string
- ended string
- engine object
engine properties
- shortName string
-
- events array of objects
events properties
- message string
- sheetId string
- objectId string
- severity string
- errorCode string
- objectType string
- sheetTitle string
- objectTitle string
- objectVisualization string
-
- result object
result properties
- openApp object
openApp properties
- steps array of objects
steps properties
- name string
- durationMilliseconds number
-
- totalDurationMilliseconds number
-
- rowCount number
- objNoCache array of objects
objNoCache properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- sheetCount number
- objectCount number
- sheetsCached array of objects
sheetsCached properties
- sheet object
sheet properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objectCount number
- sheetObjects array of objects
sheetObjects properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
-
- objSlowCached array of objects
objSlowCached properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objMemoryLimit array of objects
objMemoryLimit properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- memoryLimitStatusCode string
-
- sheetsUncached array of objects
sheetsUncached properties
- sheet object
sheet properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- objectCount number
- sheetObjects array of objects
sheetObjects properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
-
- documentSizeMiB number
- objSlowUncached array of objects
objSlowUncached properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- timeoutStatusCode string
- responseTimeSeconds number
-
- hasSectionAccess boolean
- topFieldsByBytes array of objects
topFieldsByBytes properties
- name string
- byteSize number
- isSystem boolean
-
- topTablesByBytes array of objects
topTablesByBytes properties
- name string
- byteSize number
- isSystem boolean
-
- objSingleThreaded array of objects
objSingleThreaded properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- cpuQuotients array of numbers
- responseTimeSeconds number
-
-
- status string
- appName string
- details object
details properties
- errors array of strings
- warnings array of strings
- objectMetrics object
additional optional properties
- object object
object properties
- id string
- title string
- sheetId string
- objectType string
- sheetTitle string
- passes array of objects
passes properties
- errorCode string
- cpuSeconds array of numbers
- cpuQuotients array of numbers
- responseTimeSeconds number
-
-
-
- engineHasCache boolean
- concurrentReload boolean
-
- started string
- version number
- tenantId string
- appItemId string
- timestamp string
- openAppProgress object
openAppProgress properties
- messages array of objects
messages properties
- message string
- timeSinceStartMilliseconds string
-
-
- reloadInformation object
reloadInformation properties
- reloadmeta object
reloadmeta properties
- cpuspent number
- peakmemorybytes number
-
- amountofrows number
- amountoffields number
- amountoftables number
- staticbytesize number
- hassectionaccess boolean
- amountoffieldvalues number
- amountofcardinalfieldvalues number
-
-
404
The specified app evaluation was not found.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
500
Internal server error.
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- status integer
-
-
GET /api /analytics /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.analytics.apps.getAppEvaluationXml( 'abcdefghijklmnopq',)qlik analytics app evaluation download 'abcdefghijklmnopq'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/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", "engine": { "shortName": "OAPE-40" }, "events": [ { "message": "An object failed", "sheetId": "gregFG", "objectId": "adfRFr", "severity": "warning", "errorCode": "ERR-GOPHERCISER", "objectType": "linechart", "sheetTitle": "mysheet", "objectTitle": "profit", "objectVisualization": "linechart" } ], "result": { "openApp": { "steps": [ { "name": "loadingFields", "durationMilliseconds": 1234 } ], "totalDurationMilliseconds": 12345 }, "rowCount": 20000, "objNoCache": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "sheetCount": 5, "objectCount": 33, "sheetsCached": [ { "sheet": { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 }, "objectCount": 1, "sheetObjects": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ] } ], "objSlowCached": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "objMemoryLimit": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "memoryLimitStatusCode": "OUT-OF-MEMORY" } ], "sheetsUncached": [ { "sheet": { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 }, "objectCount": 1, "sheetObjects": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ] } ], "documentSizeMiB": 12.3, "objSlowUncached": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "timeoutStatusCode": "CALC-TIMEOUT", "responseTimeSeconds": 12.3 } ], "hasSectionAccess": false, "topFieldsByBytes": [ { "name": "some field/table", "byteSize": 12873, "isSystem": false } ], "topTablesByBytes": [ { "name": "some field/table", "byteSize": 12873, "isSystem": false } ], "objSingleThreaded": [ { "id": "fjETFn", "title": "my chart", "sheetId": "41dbb01c-d1bd-4528-be05-910ee565988b", "objectType": "table", "sheetTitle": "my sheet", "cpuQuotients": [ 12.3 ], "responseTimeSeconds": 12.3 } ] }, "status": "finished", "appName": "my app", "details": { "errors": [ "this is an error" ], "warnings": [ "this is a warning" ], "objectMetrics": {}, "engineHasCache": false, "concurrentReload": false }, "started": "2022-02-09T06:58:40.575Z", "version": 1, "tenantId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn", "appItemId": "zyb2bQTeFmPVt9TXZOS0I5GZCFn", "timestamp": "2022-02-09T06:58:40.575Z", "openAppProgress": { "messages": [ { "message": "TODO", "timeSinceStartMilliseconds": "TODO" } ] }, "reloadInformation": { "reloadmeta": { "cpuspent": "123983", "peakmemorybytes": 112 }, "amountofrows": 1423423234, "amountoffields": 12, "amountoftables": 7, "staticbytesize": 1444234, "hassectionaccess": false, "amountoffieldvalues": 144423433, "amountofcardinalfieldvalues": 14442 }}