ancoreMate Apps (Preview)
Manage Qlik Sense® apps in Qlik Cloud®: create, copy, publish, move, export and import apps (QVF), maintain media files, load scripts, data preparation scripts and performance evaluations. Triggers when an app is created, published, exported or its data model changes. Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | ancoreSoft |
| URL | https://ancorecloud.com/ |
| support@ancoresoft.com |
| Connector Metadata | |
|---|---|
| Publisher | ancoreSoft |
| Website | https://ancorecloud.com/ |
| Privacy policy | https://ancoresoft.com/legal/ancoremate/privacy/ |
| Categories | Data;Business Intelligence |
ancoreMate Apps
Manage Qlik Sense® apps in Qlik Cloud®: create, copy, publish, move, export and import apps (QVF), maintain media files, load scripts, data preparation scripts and performance evaluations. Triggers when an app is created, published, exported or its data model changes.
Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.
Publisher
ancoreSoft
Prerequisites
- An ancoreCloud account with an ancoreMate subscription. See https://ancorecloud.com/ for details and https://docs.ancoresoft.com/ for the documentation.
- A Qlik Cloud user with access to the content you want to automate. No OAuth client, client ID or API key needs to be created in Qlik Cloud.
Supported operations
Change app owner
Transfers an app to another user.
Copy app
Creates a copy of an app, optionally with a new name or in another space.
Create app
Creates an empty app.
Create script
Creates an empty script in a space or the personal space.
Delete app
Deletes an app.
Delete app media file
Deletes a file from the media library of an app.
Delete script
Deletes a script.
Evaluate app performance
Starts a performance evaluation of an app. Get the result with Get app evaluation.
Export app
Exports an app as QVF file, optionally without data. Files up to 30 MB can be sent and files up to 50 MB returned.
Get Qlik connection
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.
Get app
Returns the attributes of an app such as name, owner, space and last reload time.
Get app data lineage
Returns the data sources the app loads from.
Get app data model
Returns the tables and fields of the app data model with their sizes.
Get app evaluation
Returns the result of a performance evaluation.
Get app media file
Downloads a file from the media library of an app, or the thumbnail of the app. Files up to 30 MB can be sent and files up to 50 MB returned.
Get load script
Returns the current load script of an app.
Get load script version
Returns a saved version of the load script of an app.
Get script
Returns the current content of a script.
Import app
Imports a QVF file as a new app into a space or the personal space. Files up to 30 MB can be sent and files up to 50 MB returned.
List app evaluations
Lists the performance evaluations of an app.
List app media files
Lists the images and other files in the media library of an app.
List apps
Lists the Qlik Sense apps of the tenant that the connected Qlik Cloud user has access to, sorted by name.
List load script versions
Lists the saved versions of the load script of an app.
List scripts
Lists the scripts, optionally filtered by name or space.
Move app to space
Moves an app to another shared space.
Publish app
Publishes an app to a managed space for the first time. Publishing the same app again creates a second published app; use Republish app to update a published app.
Republish app
Replaces a published app in a managed space with the current version of the source app.
Send Qlik Cloud request
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.
Set load script
Replaces the load script of an app and keeps the previous script as a version.
Update app
Changes the name or description of an app.
Update script
Replaces the content of a script and keeps the previous content as a version.
Upload app media file
Uploads an image or other file into the media library of an app; an existing file is replaced. Files up to 30 MB can be sent and files up to 50 MB returned.
Validate load script
Checks a load script for basic errors such as unknown statements, without saving or running it; errors in the details of a statement are found only when the app is reloaded.
Supported triggers
When an app is created
Starts when an app is created.
When an app is exported
Starts when an app is exported.
When an app is published
Starts when an app is published to a managed space.
When the data model of an app changes
Starts when the data model of an app is updated, for example by a reload with changed tables.
Obtaining credentials
- Create a connection and select Sign in.
- Sign in with your ancoreCloud account.
- The first time, enter your Qlik Cloud tenant, for example
company.eu.qlikcloud.com, sign in at Qlik Cloud and approve the access for ancoreMate. Later sign-ins list the Qlik Cloud connections of your ancoreCloud account: continue with one of them, or add another tenant or Qlik user. Each connection works with the Qlik Cloud connection chosen in its sign-in; the others stay as they are. - If your Qlik Cloud administrators require it, an administrator approves ancoreMate once in the Qlik Cloud administration (Integrations > OAuth).
Getting started
Create a flow that runs every night, uses List apps with a space to find the apps of a project and Copy app to make a backup copy of each app in an archive space.
Known issues and limitations
- Exporting and importing apps transfers the QVF file through the flow; files larger than 50 MB are not supported.
- List apps and the app lists in the actions show the apps the connected Qlik Cloud user can see. A tenant administrator sees more apps with an API key (also the personal spaces of other users) than through ancoreMate, which always acts as the connected user.
- Publish app creates a new published app each time it runs; to update a published app use Republish app.
- Apps in a managed space can only be exported without data.
- Only Qlik Cloud tenants are supported; Qlik Sense client-managed (on-premises) deployments are not supported.
- Qlik Cloud rate limits apply. When Qlik Cloud limits requests, the action fails with status 429; the flow's retry policy retries it automatically.
- Each connection works with one Qlik Cloud tenant and Qlik user, chosen in its sign-in. To work with several tenants or Qlik users, for example development and production, create one connection per tenant or user; a flow can use several of them.
Deployment instructions
Use the instructions to deploy a custom connector with the files apiDefinition.swagger.json and apiProperties.json of this folder.
Actions
| Change app owner |
Transfers an app to another user. |
| Copy app |
Creates a copy of an app, optionally with a new name or in another space. |
| Create app |
Creates an empty app. |
| Create script |
Creates an empty script in a space or the personal space. |
| Delete app |
Deletes an app. |
| Delete app media file |
Deletes a file from the media library of an app. |
| Delete script |
Deletes a script. |
| Evaluate app performance |
Starts a performance evaluation of an app. Get the result with Get app evaluation. |
| Export app |
Exports an app as QVF file, optionally without data. Files up to 30 MB can be sent and files up to 50 MB returned. |
| Get app |
Returns the attributes of an app such as name, owner, space and last reload time. |
| Get app data lineage |
Returns the data sources the app loads from. |
| Get app data model |
Returns the tables and fields of the app data model with their sizes. |
| Get app evaluation |
Returns the result of a performance evaluation. |
| Get app media file |
Downloads a file from the media library of an app, or the thumbnail of the app. Files up to 30 MB can be sent and files up to 50 MB returned. |
| Get load script |
Returns the current load script of an app. |
| Get load script version |
Returns a saved version of the load script of an app. |
| Get Qlik connection |
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user. |
| Get script |
Returns the current content of a script. |
| Import app |
Imports a QVF file as a new app into a space or the personal space. Files up to 30 MB can be sent and files up to 50 MB returned. |
| List app evaluations |
Lists the performance evaluations of an app. |
| List app media files |
Lists the images and other files in the media library of an app. |
| List apps |
Lists the Qlik Sense apps of the tenant that the connected Qlik Cloud user has access to, sorted by name. |
| List load script versions |
Lists the saved versions of the load script of an app. |
| List scripts |
Lists the scripts, optionally filtered by name or space. |
| Move app to space |
Moves an app to another shared space. |
| Publish app |
Publishes an app to a managed space for the first time. Publishing the same app again creates a second published app; use Republish app to update a published app. |
| Republish app |
Replaces a published app in a managed space with the current version of the source app. |
| Send Qlik Cloud request |
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own. |
| Set load script |
Replaces the load script of an app and keeps the previous script as a version. |
| Update app |
Changes the name or description of an app. |
| Update script |
Replaces the content of a script and keeps the previous content as a version. |
| Upload app media file |
Uploads an image or other file into the media library of an app; an existing file is replaced. Files up to 30 MB can be sent and files up to 50 MB returned. |
| Validate load script |
Checks a load script for basic errors such as unknown statements, without saving or running it; errors in the details of a statement are found only when the app is reloaded. |
Change app owner
Transfers an app to another user.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Owner ID
|
ownerId | True | string |
The ID of the new owner. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Copy app
Creates a copy of an app, optionally with a new name or in another space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Name
|
name | string |
The name of the copy. Leave empty to keep the name. |
|
|
Description
|
description | string |
The description of the copy. |
|
|
Space ID
|
spaceId | string |
The space for the copy. Leave empty for the same space. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Create app
Creates an empty app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
The name of the app. |
|
Description
|
description | string |
The description of the app. |
|
|
Space ID
|
spaceId | string |
The space to create the app in. Leave empty for the personal space. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Create script
Creates an empty script in a space or the personal space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
The name of the script. |
|
Description
|
description | string |
The description of the app. |
|
|
Space ID
|
spaceId | string |
The space to create the app in. Leave empty for the personal space. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Delete app
Deletes an app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
Delete app media file
Deletes a file from the media library of an app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App
|
appId | True | string |
The app. |
|
Path
|
path | True | string |
The path of the media file, for example logo.png or images/logo.png. |
Delete script
Deletes a script.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Script ID
|
scriptId | True | string |
Identifier of the app. |
Evaluate app performance
Starts a performance evaluation of an app. Get the result with Get app evaluation.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Guid of the app. |
Returns
An app evaluation.
- Body
- AppEvaluation
Export app
Exports an app as QVF file, optionally without data. Files up to 30 MB can be sent and files up to 50 MB returned.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App
|
appId | True | string |
The app. |
|
Without data
|
withoutData | boolean |
Exports only the structure and the load script, without data. |
|
|
File name
|
fileName | string |
The name of the file. Default is the name of the app and the time (UTC), for example Sales_2026-10-02_1015.qvf. |
Returns
A file returned by an action.
- Body
- File
Get app
Returns the attributes of an app such as name, owner, space and last reload time.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Get app data lineage
Returns the data sources the app loads from.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
Returns
The result of get app data lineage.
Get app data model
Returns the tables and fields of the app data model with their sizes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
Returns
The result of get app data model.
Get app evaluation
Returns the result of a performance evaluation.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Evaluation ID
|
evaluationId | True | string |
Id of the desired evaluation. |
|
All
|
all | boolean |
Get the full data of the evaluation. |
Returns
An app evaluation.
- Body
- AppEvaluation
Get app media file
Downloads a file from the media library of an app, or the thumbnail of the app. Files up to 30 MB can be sent and files up to 50 MB returned.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App
|
appId | True | string |
The app. |
|
Path
|
path | string |
The path of the media file, for example logo.png. Not needed for the thumbnail. |
|
|
Thumbnail
|
thumbnail | boolean |
Returns the thumbnail of the app instead of a media file. |
Returns
A file returned by an action.
- Body
- File
Get load script
Returns the current load script of an app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
Returns
A load script.
- Body
- LoadScript
Get load script version
Returns a saved version of the load script of an app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Version ID
|
versionId | True | string |
Identifier of the script version, or 'current' for retrieving the current version. |
Returns
A load script.
- Body
- LoadScript
Get Qlik connection
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.
Returns
The connection between ancoreMate and Qlik Cloud.
- Body
- Connection
Get script
Returns the current content of a script.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Script ID
|
scriptId | True | string |
Identifier of the app. |
Returns
A script.
- Body
- GetScriptResponse
Import app
Imports a QVF file as a new app into a space or the personal space. Files up to 30 MB can be sent and files up to 50 MB returned.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | string |
The name of the new app. Default is the name stored in the file. |
|
|
Space ID
|
spaceId | string |
The space of the new app. Leave empty for the personal space. |
|
|
File content
|
file | True | binary |
The QVF file. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
List app evaluations
Lists the performance evaluations of an app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
The app guid. |
|
Sort
|
sort | string |
Property to sort list on. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of app evaluation items.
- Body
- AppEvaluationList
List app media files
Lists the images and other files in the media library of an app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App
|
appId | True | string |
The app. |
|
Folder
|
folder | string |
A folder within the media library. Leave empty for all files. |
Returns
The files of the media library.
- Body
- MediaFileList
List apps
Lists the Qlik Sense apps of the tenant that the connected Qlik Cloud user has access to, sorted by name.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Search
|
search | string |
Returns only apps whose name contains this text. |
|
|
Space
|
spaceId | string |
Returns only the apps of this space; personal for your personal space. Leave empty for all apps. |
|
|
Limit
|
limit | integer |
The maximum number of apps to return, between 1 and 1000. |
Returns
A list of Qlik Sense apps.
- Body
- AppList
List load script versions
Lists the saved versions of the load script of an app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of load script items.
List scripts
Lists the scripts, optionally filtered by name or space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | string |
The case-insensitive string used to search for a resource by name. |
|
|
Sort
|
sort | string |
The property of a resource to sort on (default sort is +createdAt). |
|
|
Space ID
|
spaceId | string |
The space's unique identifier (supports 'personal' as spaceId). |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of script items.
- Body
- ScriptItemList
Move app to space
Moves an app to another shared space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Space ID
|
spaceId | True | string |
The ID of the target space. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Publish app
Publishes an app to a managed space for the first time. Publishing the same app again creates a second published app; use Republish app to update a published app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Data
|
data | string |
Which data the published app gets: source (the data of the source app, the default) or target (the published app keeps its current data, for Republish app). |
|
|
Move App
|
moveApp | boolean |
The original is moved instead of copied. |
|
|
Space ID
|
spaceId | string |
The managed space ID where the app will be published. |
|
|
Name
|
name | string |
The name (title) of the application. |
|
|
Description
|
description | string |
The description of the application. |
|
|
Origin App ID
|
originAppId | string |
If app is moved, originAppId needs to be provided. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Republish app
Replaces a published app in a managed space with the current version of the source app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Data
|
data | string |
Which data the published app gets: source (the data of the source app, the default) or target (the published app keeps its current data, for Republish app). |
|
|
Target ID
|
targetId | string |
The target ID to be republished. |
|
|
Name
|
name | string |
The name (title) of the application. |
|
|
Description
|
description | string |
The description of the application. |
|
|
Check Origin App ID
|
checkOriginAppId | boolean |
Validate that source app is same as originally published. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Send Qlik Cloud request
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Method
|
method | True | string |
The HTTP method. |
|
Path
|
path | True | string |
The path below /api/v1/, for example spaces or apps/1234/reloads/logs. |
|
Query
|
query | string |
Query parameters as in a URL, for example limit=10&name=Sales. |
|
|
Body
|
body | object |
The JSON body for POST, PUT, PATCH and DELETE, for example the IDs of the items to delete. |
Returns
The JSON response of Qlik Cloud, unchanged.
- response
- object
Set load script
Replaces the load script of an app and keeps the previous script as a version.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Script
|
script | True | string |
The complete load script. |
|
Version message
|
versionMessage | string |
A description of this script version. |
Update app
Changes the name or description of an app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
Identifier of the app. |
|
Name
|
name | string |
The new name of the app. |
|
|
Description
|
description | string |
The new description of the app. |
Returns
Application attributes and user privileges.
- Body
- AppDetails
Update script
Replaces the content of a script and keeps the previous content as a version.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Script ID
|
scriptId | True | string |
Identifier of the app. |
|
Script
|
script | True | string |
The complete script. |
|
Version message
|
versionMessage | string |
A description of this version. |
Upload app media file
Uploads an image or other file into the media library of an app; an existing file is replaced. Files up to 30 MB can be sent and files up to 50 MB returned.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App
|
appId | True | string |
The app. |
|
Path
|
path | True | string |
The path of the media file, for example logo.png or images/logo.png. |
|
File content
|
file | True | binary |
The file to upload. |
Validate load script
Checks a load script for basic errors such as unknown statements, without saving or running it; errors in the details of a statement are found only when the app is reloaded.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Script
|
script | True | string |
The load script to check. |
Returns
A load script.
- Body
- LoadScriptIssues
Triggers
| When an app is created |
Starts when an app is created. |
| When an app is exported |
Starts when an app is exported. |
| When an app is published |
Starts when an app is published to a managed space. |
| When the data model of an app changes |
Starts when the data model of an app is updated, for example by a reload with changed tables. |
When an app is created
Starts when an app is created.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
When an app is exported
Starts when an app is exported.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App
|
appId | string |
Only events of this app. Leave empty for all apps. |
|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
When an app is published
Starts when an app is published to a managed space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App
|
appId | string |
Only when this app is published (the app in the source space). Leave empty for all apps. |
|
|
Managed space
|
spaceId | string |
Only publications to this managed space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
When the data model of an app changes
Starts when the data model of an app is updated, for example by a reload with changed tables.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App
|
appId | string |
Only events of this app. Leave empty for all apps. |
|
|
Space
|
spaceId | string |
Only events in this space. Leave empty for all spaces. |
Returns
An event of Qlik Cloud.
- Body
- QlikEvent
Definitions
App
A Qlik Sense app.
| Name | Path | Type | Description |
|---|---|---|---|
|
App ID
|
id | string |
The unique identifier of the app. |
|
App name
|
name | string |
The name of the app. |
|
App description
|
description | string |
The description of the app, if one is set. |
|
Space ID
|
spaceId | string |
The identifier of the space the app belongs to. Empty for apps in a personal space. |
|
Owner ID
|
ownerId | string |
The identifier of the user who owns the app. |
|
Updated at
|
updatedAt | date-time |
The time the app was last updated. |
|
Created at
|
createdAt | date-time |
The time the app was created. |
|
Last reload
|
lastReloadTime | date-time |
The end of the last reload. Empty if the app was never reloaded. |
|
Last reload status
|
lastReloadStatus | string |
The result of the last reload, for example ok or error. |
AppDetails
Application attributes and user privileges.
| Name | Path | Type | Description |
|---|---|---|---|
|
Create
|
create | array of object |
Object create privileges. |
|
Resource
|
create.resource | string |
Type of resource. |
|
Can Create
|
create.canCreate | boolean |
Is set to true if the user has privileges to create the resource. |
|
ID
|
attributes.id | string |
The App ID. |
|
Name
|
attributes.name | string |
App name. |
|
Owner
|
attributes.owner | string |
Deprecated. |
|
Usage
|
attributes.usage | string |
The usage. |
|
Custom
|
attributes.custom | object |
Contains dynamic JSON data specified by the client. |
|
Owner ID
|
attributes.ownerId | string |
Identifier of the app owner. |
|
Encrypted
|
attributes.encrypted | boolean |
If set to true, the app is encrypted. |
|
Published
|
attributes.published | boolean |
For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. |
|
Thumbnail
|
attributes.thumbnail | string |
App thumbnail. |
|
Created Date
|
attributes.createdDate | date-time |
The date and time when the app was created. |
|
Description
|
attributes.description | string |
App description. |
|
Origin App ID
|
attributes.originAppId | string |
The Origin App ID for published apps. |
|
Publish Time
|
attributes.publishTime | date-time |
The date and time when the app was published, empty if unpublished. |
|
Dynamic Color
|
attributes.dynamicColor | string |
The dynamic color of the app. |
|
Modified Date
|
attributes.modifiedDate | date-time |
The date and time when the app was modified. |
|
Last Reload Time
|
attributes.lastReloadTime | date-time |
Date and time of the last reload of the app. |
|
Has Section Access
|
attributes.hasSectionAccess | boolean |
If set to true, the app has section access configured. |
|
Is Direct Query Mode
|
attributes.isDirectQueryMode | boolean |
True if the app is a Direct Query app, false if not. |
|
Privileges
|
privileges | array of string |
Application privileges. |
AppEvaluation
An app evaluation.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The id. |
|
App ID
|
appId | string |
The app id. |
|
Ended
|
ended | date-time |
The ended. |
|
Events
|
events | array of object |
The events. |
|
Details
|
events.details | string |
The details. |
|
Sheet ID
|
events.sheetId | string |
The sheet id. |
|
Object ID
|
events.objectId | string |
The object id. |
|
Severity
|
events.severity | string |
The severity. |
|
Error Code
|
events.errorCode | string |
The error code. |
|
Object Type
|
events.objectType | string |
The object type. |
|
Sheet Title
|
events.sheetTitle | string |
The sheet title. |
|
Object Title
|
events.objectTitle | string |
The object title. |
|
Object Visualization
|
events.objectVisualization | string |
The object visualization. |
|
Sheets
|
result.sheets | array of object |
The sheets. |
|
Sheet
|
result.sheets.sheet | object |
The sheet. |
|
Object Count
|
result.sheets.objectCount | number |
The object count. |
|
Sheet Objects
|
result.sheets.sheetObjects | array of object |
The sheet objects. |
|
items
|
result.sheets.sheetObjects | object |
An item. |
|
Row Count
|
result.rowCount | number |
The row count. |
|
Obj No Cache
|
result.objNoCache | array of object |
The obj no cache. |
|
ID
|
result.objNoCache.id | string |
The id. |
|
Title
|
result.objNoCache.title | string |
The title. |
|
Sheet ID
|
result.objNoCache.sheetId | string |
The sheet id. |
|
Object Type
|
result.objNoCache.objectType | string |
The object type. |
|
Timeout Status Code
|
result.objNoCache.timeoutStatusCode | string |
The timeout status code. |
|
Response Time Seconds
|
result.objNoCache.responseTimeSeconds | number |
The response time seconds. |
|
Sheet Count
|
result.sheetCount | number |
The sheet count. |
|
Object Count
|
result.objectCount | number |
The object count. |
|
Obj Slow Cached
|
result.objSlowCached | array of object |
The obj slow cached. |
|
ID
|
result.objSlowCached.id | string |
The id. |
|
Title
|
result.objSlowCached.title | string |
The title. |
|
Sheet ID
|
result.objSlowCached.sheetId | string |
The sheet id. |
|
Object Type
|
result.objSlowCached.objectType | string |
The object type. |
|
Timeout Status Code
|
result.objSlowCached.timeoutStatusCode | string |
The timeout status code. |
|
Response Time Seconds
|
result.objSlowCached.responseTimeSeconds | number |
The response time seconds. |
|
Obj Memory Limit
|
result.objMemoryLimit | array of object |
The obj memory limit. |
|
ID
|
result.objMemoryLimit.id | string |
The id. |
|
Title
|
result.objMemoryLimit.title | string |
The title. |
|
Sheet ID
|
result.objMemoryLimit.sheetId | string |
The sheet id. |
|
Object Type
|
result.objMemoryLimit.objectType | string |
The object type. |
|
Memory Limit Status Code
|
result.objMemoryLimit.memoryLimitStatusCode | string |
The memory limit status code. |
|
Document Size Mi B
|
result.documentSizeMiB | number |
The document size mi b. |
|
Obj Slow Uncached
|
result.objSlowUncached | array of object |
The obj slow uncached. |
|
ID
|
result.objSlowUncached.id | string |
The id. |
|
Title
|
result.objSlowUncached.title | string |
The title. |
|
Sheet ID
|
result.objSlowUncached.sheetId | string |
The sheet id. |
|
Object Type
|
result.objSlowUncached.objectType | string |
The object type. |
|
Timeout Status Code
|
result.objSlowUncached.timeoutStatusCode | string |
The timeout status code. |
|
Response Time Seconds
|
result.objSlowUncached.responseTimeSeconds | number |
The response time seconds. |
|
Has Section Access
|
result.hasSectionAccess | boolean |
The has section access. |
|
Top Fields By Bytes
|
result.topFieldsByBytes | array of object |
The top fields by bytes. |
|
Name
|
result.topFieldsByBytes.name | string |
The name. |
|
Byte size
|
result.topFieldsByBytes.byte_size | number |
The byte size. |
|
Is system
|
result.topFieldsByBytes.is_system | boolean |
The is system. |
|
Top Tables By Bytes
|
result.topTablesByBytes | array of object |
The top tables by bytes. |
|
Name
|
result.topTablesByBytes.name | string |
The name. |
|
Byte size
|
result.topTablesByBytes.byte_size | number |
The byte size. |
|
Is system
|
result.topTablesByBytes.is_system | boolean |
The is system. |
|
Obj Single Threaded
|
result.objSingleThreaded | array of object |
The obj single threaded. |
|
ID
|
result.objSingleThreaded.id | string |
The id. |
|
Title
|
result.objSingleThreaded.title | string |
The title. |
|
Sheet ID
|
result.objSingleThreaded.sheetId | string |
The sheet id. |
|
Object Type
|
result.objSingleThreaded.objectType | string |
The object type. |
|
Cpu Quotient1
|
result.objSingleThreaded.cpuQuotient1 | number |
The cpu quotient1. |
|
Status
|
status | string |
The status. |
|
App Name
|
appName | string |
The app name. |
|
Errors
|
details.errors | array of string |
The errors. |
|
Warnings
|
details.warnings | array of string |
The warnings. |
|
Object Metrics
|
details.objectMetrics | object |
The object metrics. |
|
Engine Has Cache
|
details.engineHasCache | boolean |
The engine has cache. |
|
Concurrent Reload
|
details.concurrentReload | boolean |
The concurrent reload. |
|
Sheet ID
|
sheetId | string |
The sheet id. |
|
Started
|
started | date-time |
The started. |
|
Version
|
version | number |
The version. |
|
Cpuspent
|
metadata.reloadmeta.cpuspent | number |
The cpuspent. |
|
Peakmemorybytes
|
metadata.reloadmeta.peakmemorybytes | number |
The peakmemorybytes. |
|
Amountofrows
|
metadata.amountofrows | number |
The amountofrows. |
|
Amountoffields
|
metadata.amountoffields | number |
The amountoffields. |
|
Amountoftables
|
metadata.amountoftables | number |
The amountoftables. |
|
Staticbytesize
|
metadata.staticbytesize | number |
The staticbytesize. |
|
Hassectionaccess
|
metadata.hassectionaccess | boolean |
The hassectionaccess. |
|
Amountoffieldvalues
|
metadata.amountoffieldvalues | number |
The amountoffieldvalues. |
|
Amountofcardinalfieldvalues
|
metadata.amountofcardinalfieldvalues | number |
The amountofcardinalfieldvalues. |
|
Tenant ID
|
tenantId | string |
The tenant id. |
|
App Item ID
|
appItemId | string |
The app item id. |
|
Timestamp
|
timestamp | date-time |
The timestamp. |
|
Sheet Title
|
sheetTitle | string |
The sheet title. |
AppEvaluationList
A list of app evaluation items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of AppEvaluation |
The items. |
AppList
A list of Qlik Sense apps.
| Name | Path | Type | Description |
|---|---|---|---|
|
Apps
|
value | array of App |
The apps, sorted by name. |
|
Truncated
|
truncated | boolean |
Whether the tenant has more apps than the limit; raise the limit or filter by space or name to get the others. |
Connection
The connection between ancoreMate and Qlik Cloud.
| Name | Path | Type | Description |
|---|---|---|---|
|
Connected
|
connected | boolean |
Whether ancoreMate is connected to Qlik Cloud. |
|
Qlik Cloud tenant
|
tenantHost | string |
The host name of the connected Qlik Cloud tenant. |
|
Qlik user
|
qlikUserName | string |
The name of the connected Qlik Cloud user. |
|
Connected at
|
connectedAt | date-time |
The time the connection was established. |
File
A file returned by an action.
| Name | Path | Type | Description |
|---|---|---|---|
|
File name
|
name | string |
The name of the file with extension, for example Customers_2026-10-02_1015.pdf. |
|
Content type
|
contentType | string |
The media type of the file, for example application/pdf. |
|
Size
|
size | integer |
The size of the file in bytes. |
|
File content
|
content | byte |
The content of the file, for example for a mail attachment or a file in SharePoint or OneDrive. |
GetAppDataLineageResponse
The result of get app data lineage.
| Name | Path | Type | Description |
|---|---|---|---|
|
Statement
|
statement | string |
The LOAD and SELECT script statements from the data load script. |
|
Discriminator
|
discriminator | string |
A string indicating the origin of the data: * [filename]: the data comes from a local file. |
GetAppDataMetadataResponse
The result of get app data model.
| Name | Path | Type | Description |
|---|---|---|---|
|
Usage
|
usage | string |
The usage. |
|
Fields
|
fields | array of object |
List of field descriptions. |
|
Hash
|
fields.hash | string |
Hash of the data in the field. |
|
Name
|
fields.name | string |
Name of the field. |
|
Tags
|
fields.tags | array of string |
Gives information on a field. |
|
Comment
|
fields.comment | string |
Field comment. |
|
Cardinal
|
fields.cardinal | integer |
Number of distinct field values. |
|
Byte size
|
fields.byte_size | integer |
Static RAM memory used in bytes. |
|
Is hidden
|
fields.is_hidden | boolean |
If set to true, the field is hidden. |
|
Is locked
|
fields.is_locked | boolean |
If set to true, the field is locked. |
|
Is system
|
fields.is_system | boolean |
If set to true, the field is a system field. |
|
Is numeric
|
fields.is_numeric | boolean |
Is set to true if the value is a numeric. |
|
Src tables
|
fields.src_tables | array of string |
List of table names. |
|
Is semantic
|
fields.is_semantic | boolean |
If set to true, the field is semantic. |
|
Total count
|
fields.total_count | integer |
Total number of field values. |
|
Distinct only
|
fields.distinct_only | boolean |
If set to true, only distinct field values are shown. |
|
Always one selected
|
fields.always_one_selected | boolean |
If set to true, the field has one and only one selection (not 0 and not more than 1). |
|
Tables
|
tables | array of object |
List of table descriptions. |
|
Name
|
tables.name | string |
Name of the table. |
|
Comment
|
tables.comment | string |
Table comment. |
|
Is loose
|
tables.is_loose | boolean |
If set to true, the table is loose due to circular connection. |
|
Byte size
|
tables.byte_size | integer |
Static RAM memory used in bytes. |
|
Is system
|
tables.is_system | boolean |
If set to true, the table is a system table. |
|
No of rows
|
tables.no_of_rows | integer |
Number of rows. |
|
Is semantic
|
tables.is_semantic | boolean |
If set to true, the table is semantic. |
|
No of fields
|
tables.no_of_fields | integer |
Number of fields. |
|
No of key fields
|
tables.no_of_key_fields | integer |
Number of key fields. |
|
Total memory
|
reload_meta.hardware.total_memory | integer |
RAM available. |
|
Logical cores
|
reload_meta.hardware.logical_cores | integer |
Number of logical cores available. |
|
Cpu time spent ms
|
reload_meta.cpu_time_spent_ms | integer |
Number of CPU milliseconds it took to reload the app. |
|
Peak memory bytes
|
reload_meta.peak_memory_bytes | integer |
Maximum number of bytes used during reload of the app. |
|
Full Reload Peak Memory Bytes
|
reload_meta.fullReloadPeakMemoryBytes | integer |
Maximum number of bytes used during full reload of the app. |
|
Partial Reload Peak Memory Bytes
|
reload_meta.partialReloadPeakMemoryBytes | integer |
Maximum number of bytes used during partial reload of the app. |
|
Static byte size
|
static_byte_size | integer |
Static memory usage for the app. |
|
Has section access
|
has_section_access | boolean |
If set to true, the app has section access configured. |
|
Is direct query mode
|
is_direct_query_mode | boolean |
The is direct query mode. |
|
Tables profiling data
|
tables_profiling_data | array of object |
Profiling data of the tables in the app. |
|
No Of Rows
|
tables_profiling_data.NoOfRows | integer |
Number of rows in the table. |
|
Field Profiling
|
tables_profiling_data.FieldProfiling | array of object |
Field values profiling info. |
|
items
|
tables_profiling_data.FieldProfiling | object |
An item. |
GetScriptResponse
A script.
| Name | Path | Type | Description |
|---|---|---|---|
|
Script
|
script | string |
Script text. |
|
Version Message
|
versionMessage | string |
Description of this script version. |
LoadScript
A load script.
| Name | Path | Type | Description |
|---|---|---|---|
|
Script
|
script | string |
Script text. |
|
Version Message
|
versionMessage | string |
Description of this script version. |
LoadScriptIssues
A load script.
| Name | Path | Type | Description |
|---|---|---|---|
|
Errors
|
Errors | array of object |
The errors. |
|
Msg
|
Errors.Msg | string |
Error or warning string. |
|
Tab
|
Errors.Tab | integer |
The index of the tab for the issue. |
|
Info
|
Errors.Info | string |
Additional information like workarounds or clarifications. |
|
Line
|
Errors.Line | integer |
Line in the tab of the issue. |
|
Column
|
Errors.Column | integer |
UTF-8 byte column of the issue. |
|
Warnings
|
Warnings | array of object |
The warnings. |
|
Msg
|
Warnings.Msg | string |
Error or warning string. |
|
Tab
|
Warnings.Tab | integer |
The index of the tab for the issue. |
|
Info
|
Warnings.Info | string |
Additional information like workarounds or clarifications. |
|
Line
|
Warnings.Line | integer |
Line in the tab of the issue. |
|
Column
|
Warnings.Column | integer |
UTF-8 byte column of the issue. |
LoadScriptVersion
A load script.
| Name | Path | Type | Description |
|---|---|---|---|
|
Size
|
size | integer |
Script size. |
|
Script ID
|
scriptId | string |
Script id. |
|
Modifier ID
|
modifierId | string |
User last modifying script version. |
|
Modified Time
|
modifiedTime | string |
Script version last modification time. |
|
Version Message
|
versionMessage | string |
Description of this script version. |
LoadScriptVersionList
A list of load script items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of LoadScriptVersion |
The items. |
MediaFile
A file or folder in the media library of an app.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The path of the file within the media library. |
|
Name
|
name | string |
The name of the file or folder. |
|
Type
|
type | string |
The type, for example image/png or folder. |
|
Link
|
link | string |
The link to the file in Qlik Cloud. |
MediaFileList
The files of the media library.
| Name | Path | Type | Description |
|---|---|---|---|
|
Files
|
value | array of MediaFile |
The files and folders. |
QlikEvent
An event of Qlik Cloud.
| Name | Path | Type | Description |
|---|---|---|---|
|
Event ID
|
id | string |
The unique ID of the event. |
|
Event type
|
type | string |
The type of the event, for example com.qlik.v1.app.reload.finished. |
|
Time
|
time | date-time |
The time of the event. |
|
Source
|
source | string |
The Qlik Cloud service that reported the event. |
|
Subject
|
subject | string |
The item the event is about. |
|
Tenant ID
|
tenantid | string |
The ID of the Qlik Cloud tenant. |
|
User ID
|
userid | string |
The ID of the user who caused the event. |
|
Owner ID
|
ownerid | string |
The ID of the user who owns the item. |
|
Space ID
|
spaceid | string |
The ID of the space of the item. |
|
Resource ID
|
toplevelresourceid | string |
The ID of the item, for example the app or automation. |
|
Data
|
data | object |
The details of the event; for apps, data.attributes holds the app with name, ID and space. |
ScriptItem
An item.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The item's unique identifier. |
|
Tags
|
meta.tags | array of object |
An array of tags that the item is part of. |
|
ID
|
meta.tags.id | string |
The ID of the tag/collection. |
|
Name
|
meta.tags.name | string |
The name of the tag/collection. |
|
Actions
|
meta.actions | array of string |
The actions that the user can perform on the item. |
|
Collections
|
meta.collections | array of object |
An array of collections that the item is part of. |
|
ID
|
meta.collections.id | string |
The ID of the tag/collection. |
|
Name
|
meta.collections.name | string |
The name of the tag/collection. |
|
Is Favorited
|
meta.isFavorited | boolean |
The flag that indicates if item is in the user's favorites collection. |
|
Name
|
name | string |
The name. |
|
Href
|
links.open.href | uri |
The href. |
|
Href
|
links.self.href | uri |
The href. |
|
Href
|
links.qvPlugin.href | uri |
The href. |
|
Href
|
links.thumbnail.href | uri |
The href. |
|
Href
|
links.collections.href | uri |
The href. |
|
Actions
|
actions | array of string |
The actions that the user can perform on the item. |
|
Owner ID
|
ownerId | string |
The ID of the user who owns the item. |
|
Space ID
|
spaceId | string |
The space's unique identifier. |
|
Tenant ID
|
tenantId | string |
The ID of the tenant that owns the item. |
|
Created At
|
createdAt | date-time |
The RFC3339 datetime when the item was created. |
|
Creator ID
|
creatorId | string |
The ID of the user who created the item. |
|
Week
|
itemViews.week | array of object |
The week. |
|
Start
|
itemViews.week.start | date-time |
The RFC3339 datetime representing the start of the referenced week. |
|
Total
|
itemViews.week.total | integer |
Total number of views the resource got during the referenced week. |
|
Unique
|
itemViews.week.unique | integer |
Number of unique users who viewed the resource during the referenced week. |
|
Total
|
itemViews.total | integer |
Total number of views the resource got during the last 28 days. |
|
Trend
|
itemViews.trend | number |
Trend in views over the last 4 weeks. |
|
Unique
|
itemViews.unique | integer |
Number of unique users who viewed the resource during the last 28 days. |
|
Used By
|
itemViews.usedBy | integer |
Number of apps this dataset is used in (datasets only). |
|
Updated At
|
updatedAt | date-time |
The RFC3339 datetime when the item was last updated. |
|
Updater ID
|
updaterId | string |
ID of the user who last updated the item. |
|
Resource ID
|
resourceId | string |
The case-sensitive string used to search for an item by resourceId. |
|
Description
|
description | string |
The description. |
|
Is Favorited
|
isFavorited | boolean |
The flag that indicates if item is in the user's favorites collection. |
|
Thumbnail ID
|
thumbnailId | string |
The item thumbnail's unique identifier. |
|
Resource Link
|
resourceLink | uri |
The case-sensitive string used to search for an item by resourceLink. |
|
App File
|
resourceSize.appFile | number |
Size of the app on disk in bytes. |
|
App Memory
|
resourceSize.appMemory | number |
Size of the app in memory in bytes. |
|
Resource Type
|
resourceType | string |
The case-sensitive string defining the item's type. |
|
Collection IDs
|
collectionIds | array of string |
The ID of the collections that the item has been added to. |
|
Resource Sub Type
|
resourceSubType | string |
Optional field defining the item's subtype, if any. |
|
Resource Created At
|
resourceCreatedAt | date-time |
The RFC3339 datetime when the resource that the item references was created. |
|
Resource Updated At
|
resourceUpdatedAt | date-time |
The RFC3339 datetime when the resource that the item references was last updated. |
|
Resource Attributes
|
resourceAttributes | object |
The resource attributes. |
|
Resource Reload Status
|
resourceReloadStatus | string |
If the resource last reload was successful or not. |
|
Resource Reload End Time
|
resourceReloadEndTime | date-time |
The RFC3339 datetime when the resource last reload ended. |
|
Resource Custom Attributes
|
resourceCustomAttributes | object |
The resource custom attributes. |
ScriptItemList
A list of script items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of ScriptItem |
The items. |
object
This is the type 'object'.