Type Alias AppsAPI

type AppsAPI = {
    clearCache: typeof apps.clearCache;
    createAppEvaluation: typeof createAppEvaluation;
    getAppEvaluation: typeof apps.getAppEvaluation;
    getAppEvaluationComparison: typeof apps.getAppEvaluationComparison;
    getAppEvaluationComparisonXml: typeof apps.getAppEvaluationComparisonXml;
    getAppEvaluations: typeof apps.getAppEvaluations;
    getAppEvaluationXml: typeof apps.getAppEvaluationXml;
    restoreApp: typeof restoreApp;
}
Index

Properties

clearCache createAppEvaluation getAppEvaluation getAppEvaluationComparison getAppEvaluationComparisonXml getAppEvaluations getAppEvaluationXml restoreApp

Properties

clearCache: typeof apps.clearCache

Clears the cache for apps api requests.

createAppEvaluation: typeof createAppEvaluation

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.

createAppEvaluation(
  "abcdefghijklmnopq"
)

The unique identifier of the app to evaluate.

CreateAppEvaluationHttpError

getAppEvaluation: typeof apps.getAppEvaluation

Retrieves a single app evaluation by its unique identifier. Use the all parameter to include full evaluation details in the response.

The unique identifier of the app evaluation to retrieve.

an object with query parameters

GetAppEvaluationHttpError

getAppEvaluationComparison: typeof apps.getAppEvaluationComparison

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.

The unique identifier of the baseline app evaluation.

The unique identifier of the comparison app evaluation.

an object with query parameters

GetAppEvaluationComparisonHttpError

getAppEvaluationComparisonXml: typeof apps.getAppEvaluationComparisonXml

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.

getAppEvaluationComparisonXml(
  "abcdefghijklmnopq",
  "abcdefghijklmnopq"
)

The unique identifier of the baseline app evaluation.

The unique identifier of the comparison app evaluation.

GetAppEvaluationComparisonXmlHttpError

getAppEvaluations: typeof apps.getAppEvaluations

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.

The unique identifier of the app.

an object with query parameters

GetAppEvaluationsHttpError

getAppEvaluationXml: typeof apps.getAppEvaluationXml

Downloads the evaluation log for the specified app evaluation, defaulting to XML format. Use the Accept header to request JSON output instead.

getAppEvaluationXml(
  "abcdefghijklmnopq"
)

The unique identifier of the app evaluation to download.

GetAppEvaluationXmlHttpError

restoreApp: typeof restoreApp

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.

Identifier of the app.

RestoreAppHttpError

Settings

Member Visibility

On This Page

Properties