Qlik Developer

https://qlik.dev/
Admin
Comprehensive documentation for developing, embedding, extending, and managing Qlik Cloud analytics...
Tokens:6,517,117
Snippets:34,247
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### qlik context get examples

Source: https://qlik.dev/toolkits/qlik-cli/context/context-get.md

Two examples: one to get the current context, and another to get a context named 'local-engine'.

```bash
qlik context get
```

```bash
qlik context get local-engine
```

--------------------------------

### JavaScript fetch example for GET /api/v1/apps/{guid}/evaluations

Source: https://qlik.dev/apis/rest/apps

Use this JavaScript fetch example to call the GET /api/v1/apps/{guid}/evaluations endpoint until qlik-api adds support. It sends a GET request with a JSON content type header.

```javascript
// qlik-api has not implemented support for `GET /api/v1/apps/{guid}/evaluations` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/apps/{guid}/evaluations',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
```

--------------------------------

### qlik app keys example

Source: https://qlik.dev/toolkits/qlik-cli/app/app-keys.md

A basic example of how to run the command.

```bash
qlik app keys
```

--------------------------------

### qlik app bookmark ls example

Source: https://qlik.dev/toolkits/qlik-cli/app/app-bookmark-ls.md

A simple example of how to execute the command.

```bash
qlik app bookmark ls
```

--------------------------------

### Get Start Pages - Example Response

Source: https://qlik.dev/apis/rest/tenant-settings.md

Example JSON response from the start-pages endpoint, showing the available start page options.

```json
{
  "values": [
    {
      "route": "/insights",
      "value": "analytics-hub"
    }
  ],
  "defaultValue": "analytics-hub"
}
```

--------------------------------

### cURL example for GET /api/v1/apps/{guid}/evaluations

Source: https://qlik.dev/apis/rest/apps

cURL command to call the GET /api/v1/apps/{guid}/evaluations endpoint. Replace {tenant}, {region}, {guid}, and <access_token> with your values.

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/apps/{guid}/evaluations" \
-H "Authorization: Bearer <access_token>"
```

--------------------------------

### qlik assistant starter help options

Source: https://qlik.dev/toolkits/qlik-cli/assistant/assistant-starter.md

Displays help information for the starter command.

```bash
  -h, --help   help for starter
```

--------------------------------

### qlik app meta examples

Source: https://qlik.dev/toolkits/qlik-cli/app/app-meta.md

Examples showing how to run the command with and without specifying an app file.

```bash
qlik app meta
qlik app meta --app my-app.qvf
```

--------------------------------

### Usage: qlik assistant starter followup

Source: https://qlik.dev/toolkits/qlik-cli/assistant/assistant-starter-followup.md

Shows the command syntax for configuring followup for starter.

```bash
qlik assistant starter followup [flags]
```

--------------------------------

### GET /api/v1/oauth-tokens response example

Source: https://qlik.dev/apis/rest/oauth-tokens.md

Example JSON response structure for the GET /api/v1/oauth-tokens endpoint.

```json
{
  "data": [
    {
      "id": "string",
      "userId": "string",
      "lastUsed": "2018-10-30T07:06:22Z",
      "tenantId": "string",
      "deviceType": "string",
      "description": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}
```

--------------------------------

### GET /api/data-governance/semantic-types examples

Source: https://qlik.dev/apis/rest/data-governance/semantic-types.md

Shows the current lack of support in qlik-api and qlik-cli for GET /api/data-governance/semantic-types, a fetch fallback, a cURL example, and an empty example response.

```javascript
// qlik-api has not implemented support for `GET /api/data-governance/semantic-types` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/data-governance/semantic-types',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
```

```bash
# qlik-cli has not implemented support for GET /api/data-governance/semantic-types yet.
```

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/semantic-types" \
-H "Authorization: Bearer <access_token>"
```

```json
{}
```

--------------------------------

### Command usage: qlik assistant starter create

Source: https://qlik.dev/toolkits/qlik-cli/assistant/assistant-starter-create.md

Shows the basic command syntax for creating a starter. Use this command with the required flags: --assistantId, --question, --recommendedAnswer-content, and --recommendedAnswer-contentType.

```bash
qlik assistant starter create [flags]
```

--------------------------------

### useTranslator() example

Source: https://qlik.dev/apis/javascript/nebula-js.md

Gets the translator. The example shows using the translator's get method to retrieve a string.

```javascript
import { useTranslator } from '@nebula.js/stardust';
// ...
const translator = useTranslator();
console.log(translator.get('SomeString'));
```

--------------------------------

### Options for qlik assistant starter followup

Source: https://qlik.dev/toolkits/qlik-cli/assistant/assistant-starter-followup.md

Lists the command-specific options, including the help flag.

```bash
  -h, --help   help for followup
```

--------------------------------

### qlik tenant-settings start-page options

Source: https://qlik.dev/toolkits/qlik-cli/tenant-settings/tenant-settings-start-page.md

Available flags for the start-page command.

```bash
  -h, --help   help for start-page
```

--------------------------------

### Example JSON response for GET /api/v1/data-files

Source: https://qlik.dev/apis/rest/data-files.md

This is an example response from the GET /api/v1/data-files endpoint, showing the structure of the returned data.

```json
{
  "data": [
    {
      "id": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
      "qri": "qri:qdf:space://ooSOGoLLaq7EMaSdSsCiGvLwcd_VAf1oU0mzwSfp_Qs#wME89c8gKu_Tpz8W_a0JKSbKC4hzbNu0NLVgqi2UFS0",
      "name": "some/folder/MyFile.csv",
      "size": 1024,
      "appId": "f34b91a1-0dc3-44ac-a847-51cb84122c84",
      "folder": true,
      "actions": [
        "Read"
      ],
      "ownerId": "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
      "spaceId": "617979737a9f56e49dea2e6e",
      "baseName": "MyFile.csv",
      "folderId": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
      "folderPath": "some/folder",
      "createdDate": "2020-07-07T20:52:40.8534780Z",
      "folderStats": {
        "totalFileCount": 50,
        "directFileCount": 50,
        "totalFolderCount": 50,
        "aggregateFileSize": 10000,
        "directFolderCount": 50,
        "totalInternalFileCount": 50,
        "directInternalFileCount": 50,
        "totalAppScopedFileCount": 50,
        "directAppScopedFileCount": 50,
        "aggregateInternalFileSize": 10000,
        "aggregateAppScopedFileSize": 10000
      },
      "modifiedDate": "2020-07-07T20:52:40.8534780Z",
      "contentUpdatedDate": "2020-07-07T20:52:40.8534780Z"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}
```

--------------------------------

### qlik app connection ls example

Source: https://qlik.dev/toolkits/qlik-cli/app/app-connection-ls.md

Example command to list all connections in the current app.

```bash
qlik app connection ls
```

--------------------------------

### GET /api/v1/data-stores - Example Response

Source: https://qlik.dev/apis/rest/data-stores

Example JSON response for the GET /api/v1/data-stores endpoint, showing the structure of the returned data.

```json
{
  "data": [
    {
      "id": "string",
      "uri": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "string",
      "ownerId": "string",
      "spaceId": "string",
      "version": 42,
      "tenantId": "string",
      "createdBy": "string",
      "properties": {},
      "createdTime": "2018-10-30T07:06:22Z",
      "description": "string",
      "technicalName": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "2018-10-30T07:06:22Z",
      "technicalDescription": "string"
    }
  ],
  "page": 42,
  "limit": 42,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 42,
  "total": 42
}
```

--------------------------------

### qlik app build examples

Source: https://qlik.dev/toolkits/qlik-cli/app/app-build.md

Two example invocations: one without flags and one with --connections and --script flags.

```bash
qlik app build
qlik app build --connections ./myconnections.yml --script ./myscript.qvs
```

--------------------------------

### Get user count with fetch, Qlik CLI, cURL, and response

Source: https://qlik.dev/apis/rest/users

Shows how to get the user count when the official SDKs lack support. The JavaScript example uses fetch with the GET method, the Qlik CLI example is a placeholder comment, the cURL example sends the GET request, and the JSON response shows the total count.

```javascript
// qlik-api has not implemented support for `GET /api/v1/users/actions/count` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/users/actions/count',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
```

```bash
# qlik-cli has not implemented support for GET /api/v1/users/actions/count yet.
```

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users/actions/count" \
-H "Authorization: Bearer <access_token>"
```

```json
{
  "total": 42
}
```

--------------------------------

### Connect to an app and apply a bookmark

Source: https://qlik.dev/embed/capability-api/customize/qlik-bookmark-interface.md

This example demonstrates configuring the Qlik environment and applying an existing bookmark using its ID.

```javascript
const config = {
  host: '<TENANT_URL>',
  prefix: '/',
  port: 443,
  isSecure: true,
  webIntegrationId: '<WEB_INTEGRATION_ID>'
};
require.config({
  baseUrl: `https://${config.host}/resources`,
  webIntegrationId: config.webIntegrationId
});
require(["js/qlik"], (qlik) =>{
  qlik.on('error', (error) => console.error(error));
  
  //open apps -- inserted here --
  const app = qlik.openApp('<APP_ID>', config);
  //apply a bookmark
  app.bookmark.apply('pPvpTN');
});
```

--------------------------------

### GET /api/v1/apps/{appId}/placement - Example response

Source: https://qlik.dev/apis/rest/apps

Example JSON response for the GET placement endpoint, showing the createdAt timestamp.

```json
{
  "createdAt": "2018-10-30T07:06:22Z"
}

```

--------------------------------

### GET /api/v1/csp-origins - Example response

Source: https://qlik.dev/apis/rest/csp-origins

Example JSON response for the GET /api/v1/csp-origins endpoint, showing the structure of the returned data and links.

```json
{
  "data": [
    {
      "name": "string",
      "imgSrc": true,
      "origin": "string",
      "fontSrc": true,
      "childSrc": true,
      "frameSrc": true,
      "mediaSrc": true,
      "styleSrc": true,
      "objectSrc": true,
      "scriptSrc": true,
      "workerSrc": true,
      "connectSrc": true,
      "formAction": true,
      "createdDate": "2018-10-30T07:06:22Z",
      "description": "string",
      "modifiedDate": "2018-10-30T07:06:22Z",
      "connectSrcWSS": true,
      "frameAncestors": true,
      "id": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}
```

--------------------------------

### qlik context create examples

Source: https://qlik.dev/toolkits/qlik-cli/context/context-create.md

Examples of creating contexts for Qlik Cloud, local engines, and Qlik Sense Enterprise on Windows.

```bash
qlik context create me@cloud --server https://my-tenant.eu.qlikcloud.com --api-key MY-API-KEY
qlik context create local --server localhost:9076 --comment "Local engine"
qlik context create me@qseow --server https://qseow.domain.com/jwt --comment "Qlik Sense Enterprise on Windows" --api-key MY-API-KEY --insecure
```

--------------------------------

### qlik raw example: GET request with query parameter

Source: https://qlik.dev/toolkits/qlik-cli/raw/raw.md

Example of sending a GET request to the 'v1/items' path with a query parameter 'name=ImportantApp'.

```bash
qlik raw get v1/items --query name=ImportantApp
```

--------------------------------

### qlik tenant-settings start-page command syntax

Source: https://qlik.dev/toolkits/qlik-cli/tenant-settings/tenant-settings-start-page.md

The base command syntax for managing tenant start pages.

```bash
qlik tenant-settings start-page [flags]
```

--------------------------------

### Example response for GET /api/v1/ml/deployments

Source: https://qlik.dev/apis/rest/ml.md

Example JSON response for the GET /api/v1/ml/deployments endpoint, showing the structure with data, meta, and links objects.

```json
{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "type": "deployment",
      "attributes": {
        "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "name": "string",
        "errors": "[{\"code\":\"AML-145\",\"title\":\"datasync dependent service error, service profile\",\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\",\"meta\":{\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\"}}]\n",
        "modelId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "ownerId": "string",
        "spaceId": "string",
        "createdAt": "string",
        "createdBy": "string",
        "updatedAt": "string",
        "deprecated": true,
        "description": "string",
        "errorMessage": "string",
        "deployedModelIds": [
          "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
        ],
        "enablePredictions": true
      }
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  }
}

```

--------------------------------

### qlik context init options

Source: https://qlik.dev/toolkits/qlik-cli/context/context-init.md

Lists the options available for the qlik context init command, including help flag.

```bash
  -h, --help   help for init
```

--------------------------------

### qlik app dimension set example

Source: https://qlik.dev/toolkits/qlik-cli/app/app-dimension-set.md

An example of how to execute the command with a specific file path.

```bash
qlik app dimension set ./my-dimensions-glob-path.json
```

--------------------------------

### GET /api/v1/apps/privileges - Example Response

Source: https://qlik.dev/apis/rest/apps

Example response for the GET /api/v1/apps/privileges endpoint. An empty array means the current user has no app privileges.

```json
[]

```
Tokens:
Raw