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.data
like other REST APIs, instead ofresponse.evaluations
- The response body
links
field is now aligned with other REST APIs,links.next
is renamed tolinks.next.href
,links.prev
is renamed tolinks.prev.href
- The download endpoints are now action endpoints; GET
/v1/evaluations/{id}/download
is replaced by GET/v1/apps/{id}/actions/download
and GET/v1/evaluations/{id}/compare/{comparisonid}/download
is 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:
spaceId
userId
maxMemoryMiB
appOpenTimeSeconds
dataModelSizeMiB
sheetTitle
responseTimeSeconds2
cardinal
total_count
no_of_rows
fileSizeMiB
More information regarding how Qlik deprecates APIs can be found in the API policy.