Deprecation of the evaluations API
The /evaluations API, used to queue evaluations of Sense apps and retrieve
various performance metrics, is being deprecated in favor of new API endpoints
more consistent with the rest of the Qlik Cloud platform. The affected API endpoints are:
- POST
/v1/evaluations - GET
/v1/evaluations - GET
/v1/evaluations/{id} - GET
/v1/evaluations/{id}/download - GET
/v1/evaluations/{baseid}/compare/{comparisonid} - GET
/v1/evaluations/{baseid}/compare/{comparisonid}/download
Migrating to the new endpoints
The capability is not being removed, and the full list of new endpoints can be found on the API reference page for apps.
In summary, the notable changes to the capability except for new paths are:
- The response body for listing evaluations now uses
response.datalike other REST APIs, instead ofresponse.evaluations - The response body
linksfield is now aligned with other REST APIs,links.nextis renamed tolinks.next.href,links.previs renamed tolinks.prev.href - The download endpoints are now action endpoints; GET
/v1/evaluations/{id}/downloadis replaced by GET/v1/apps/{id}/actions/downloadand GET/v1/evaluations/{id}/compare/{comparisonid}/downloadis replaced by GET/v1/apps/{id}/actions/compare/{comparisonid}/actions/download - A few fields were dropped as they were either deemed redundant, (technically) unused,
or may cause confusion:
spaceIduserIdmaxMemoryMiBappOpenTimeSecondsdataModelSizeMiBsheetTitleresponseTimeSeconds2cardinaltotal_countno_of_rowsfileSizeMiB
More information regarding how Qlik deprecates APIs can be found in the API policy.