### Example Response for Tenant Start Pages

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

Illustrates the expected JSON structure for tenant start page settings, including routes and default values.

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

```

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

### Start Local Web Server (Node.js)

Source: https://qlik.dev/embed/qlik-embed/qlik-embed-webcomponent-quickstart

Start a local web server using Node.js and http-server to serve your HTML files. Ensure you have http-server installed globally or use npx.

```bash
npx http-server -p 8080

```

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

### Example Response for Get Assistant Starters

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

Illustrates the structure of a successful response when retrieving assistant starters.

```json
{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "question": "Where was Genghis Khan buried?",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "followups": [
        {
          "id": "507f191e810c19729de860ea",
          "question": "Where was Genghis Khan buried?",
          "additionalContext": "string",
          "recommendedAnswer": {
            "content": "string",
            "contentType": "text | markdown | html"
          }
        }
      ],
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "additionalContext": "string",
      "recommendedAnswer": {
        "content": "string",
        "contentType": "text | markdown | html"
      }
    }
  ],
  "meta": {
    "countTotal": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

```

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

### Synopsis for qlik assistant starter create

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

This is the basic command structure for creating a new starter for the assistant.

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

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

### Example Task Start Response

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

A successful response when a task is started.

```json
{
  "message": "Task started successfully"
}

```

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

### Install enigma-go

Source: https://qlik.dev/toolkits/enigma-go.md

Install the enigma-go library using the go get command.

```bash
go get -u github.com/qlik-oss/enigma-go/v4
```

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

### Start the development server

Source: https://qlik.dev/extend/extend-quickstarts/first-extension.md

Navigate to the project directory and start the local development server to preview your extension. This command also opens the extension in your browser.

```bash
cd hello
npm run start
```

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

### Example: Set App Script

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

An example demonstrating how to set the app script using a local QVS file.

```bash
qlik app script set ./my-script-file.qvs
```

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

### Get Lineage Request Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

This is an example of a JSON-RPC request to the GetLineage method.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetLineage"
}

```

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

### Get Locale Info Request Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

This is an example of a JSON-RPC request to the GetLocaleInfo method.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetLocaleInfo"
}

```

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

### Example: Set App Connections

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

An example demonstrating how to use the 'qlik app connection set' command with a local YAML file named 'my-connections.yml'.

```bash
qlik app connection set ./my-connections.yml
```

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

### Example GET /api/v1/banners Response

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

This is an example of the JSON response structure when retrieving banners.

```json
{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "info",
  "enabled": true,
  "endTime": "2024-01-01T00:00:00.000Z",
  "linkUrl": "string",
  "message": "string",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "linkLabel": "string",
  "startTime": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "updatedBy": "string",
  "linkEnabled": true
}

```

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

### Example Response for Sync Operation

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

This is an example of a successful response when starting a sync operation for a datasource.

```json
{
  "id": "60b8e4e4b1f1b1001f7f1f1f"
}

```

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

### Synopsis for qlik assistant starter get

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

This is the basic command structure for retrieving a starter. You must provide the starter ID.

```bash
qlik assistant starter get <starterId> [flags]
```

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

### Get Media List Request Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

Example JSON-RPC request payload for the GetMediaList method.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetMediaList"
}

```

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

### Complete Hello World Extension Example with Qlik API

Source: https://qlik.dev/extend/create-with-extension-api/create-extension-on-the-fly.md

A full example demonstrating how to configure requireJS, connect to a Qlik Sense app, register a 'Hello World' extension, and create a visualization using it. Ensure you replace placeholders like <TENANT_URL>, <WEB_INTEGRATION_ID>, and <APP_ID> with your specific values.

```javascript
const config = {
  host: '<TENANT_URL>', //for example, 'abc.us.example.com'
  prefix: '/',
  port: 443,
  isSecure: true,
  webIntegrationId: '<WEB_INTEGRATION_ID>'
};

 require.config({
    baseUrl: `https://${config.host}/resources`,
    webIntegrationId: config.webIntegrationId
  });

  //define the helloworld extension
  const helloworld = {
    paint: ($element)=> {
      $element.html( "Hello world!!" );
    }
  }

  require(["js/qlik"], (qlik) => {
    qlik.on('error', (error) => console.error(error));
    //register the extension
    qlik.registerExtension( 'helloworld', helloworld );

    const app = qlik.openApp('<APP_ID>', config);
    //create and show an object using the extension
    app.visualization.create( 'helloworld', ["Case Owner Group"] ).then(
     ( helloworld )=> {
       helloworld.show( "QV00" );
     });
  });
```

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

### Get Tenant Start Pages

Source: https://qlik.dev/specs/rest/tenant-settings.json

Retrieves the start pages configured for the tenant settings. This endpoint allows users to fetch the current start page configurations.

```APIDOC
## GET /api/v1/tenant-settings/start-pages

### Description
Retrieves start pages for the tenant settings.

### Method
GET

### Endpoint
/api/v1/tenant-settings/start-pages

### Response
#### Success Response (200)
- **TenantStartPagesResponse** (object) - An object containing the tenant's start pages configuration.

#### Error Response
- **default** - Error response.
```

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

### Hello World QEXT File Example

Source: https://qlik.dev/extend/create-with-extension-api/qext-file-overview.md

This is a basic example of a QEXT file for a 'Hello World' visualization extension. It includes mandatory properties like name, description, type, and optional properties like preview, version, and author.

```javascript
{
    "name": "Hello World",
    "description": "Hello world example",
    "preview": "helloworld.png",
    "type": "visualization",
    "version": 1,
    "author": "Qlik International"
}
```

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

### Install New Visualization Module

Source: https://qlik.dev/embed/nebula/quickstart/build-a-simple-mashup.md

Add a new visualization type to your project by installing its npm package. This example shows how to install the pie chart module.

```bash
npm install @nebula.js/sn-pie-chart
```

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

### Options for qlik assistant starter create

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

These are the specific flags available for the 'create' command, including required parameters for assistant ID, follow-ups, questions, and recommended answers.

```bash
      --additionalContext string                         Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
      --assistantId string                               (Required) The ID of the assistant in which to create the starter.
  -f, --file file                                        Read request body from the specified file
      --followups-additionalContext string               (Required) Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
      --followups-id string                              (Required) Unique identifier of the Followup.
      --followups-question string                        (Required) Starter sample question.
      --followups-recommendedAnswer-content string       (Required) Starter answer content.
      --followups-recommendedAnswer-contentType string   (Required) Answer type of content.
  -h, --help                                             help for create
      --interval int                                     Duration in seconds to wait between retries, at least 1 (default 1)
      --question string                                  (Required) Starter sample question.
  -q, --quiet                                            Return only IDs from the command
      --raw                                              Return original response from server without any processing
      --recommendedAnswer-content string                 (Required) Starter answer content.
      --recommendedAnswer-contentType string             (Required) Answer type of content.
      --retry int                                        Number of retries to do before failing, max 10
```

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

### Get Object Request Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

Example JSON-RPC request payload for the GetObject method, specifying the object ID.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetObject",
  "params": {
    "qId": "value"
  }
}

```

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

### Qlik CLI Assistant Starter Help Flag

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

Use the -h or --help flag to display help information for the starter command.

```bash
qlik assistant starter --help
```

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

### Get Lineage Response Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

This is an example of a successful JSON-RPC response from the GetLineage method, including qLineage details.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qLineage": [
      {
        "qDiscriminator": "value",
        "qStatement": "value"
      }
    ]
  }
}

```

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

### Synopsis for qlik tenant create

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

The basic command structure for creating a tenant. Use this as a starting point for provisioning.

```bash
qlik tenant create [flags]
```

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

### Example Response for GET Brand File

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

A sample JSON response for a successful GET request for a brand file.

```json
"string"

```

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

### Set up environment configuration

Source: https://qlik.dev/toolkits/qlik-api/guides/app-sheet-list-objects.md

Create a .env file in your project root to store Qlik Cloud tenant details and app ID. Set SAVE_LAYOUTS to true to inspect object layouts.

```bash
QLIK_HOST=your-tenant.region.qlikcloud.com
QLIK_CLIENT_ID=your-client-id
QLIK_CLIENT_SECRET=your-client-secret
QLIK_APP_ID=your-app-id
SAVE_LAYOUTS=false
```

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

### Data Task Started Event Example

Source: https://qlik.dev/apis/event/di-projects.md

This JSON object represents a 'Data task started' event. It includes details about the task, when it started, who started it, and other CloudEvents metadata. Use this as a reference for the expected event structure.

```json
{
  "id": "8b6adb1b-d6dd-47bd-ab3d-17d231166ba7",
  "data": {
    "dataTask": {
      "id": "bad_storage-lbx4",
      "name": "Bad Storage",
      "type": "LANDING",
      "ownerId": "68064bc230525613f366b4f1",
      "spaceId": "68079b4004d7603de4991dcc",
      "projectId": "68172bbc045ae3756c1ae309",
      "description": "this storage has bad connection"
    },
    "startTime": "2025-05-26T11:48:14.890Z",
    "startedBy": "6819cec4fb2b973f77b77383",
    "startMethod": "USER"
  },
  "time": "2025-05-26T11:48:15.004Z",
  "type": "com.qlik.v1.di-projects.di-tasks.started",
  "source": "com.qlik/data-app-design",
  "userid": "string",
  "subject": "some-subject",
  "tenantid": "string",
  "dataschema": "https://example.com/schema",
  "extensions": {
    "actor": {},
    "updates": [
      {}
    ]
  },
  "specversion": "1.0",
  "datacontenttype": "application/json"
}
```

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

### Fetch Starter Data with cURL

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

This cURL command demonstrates how to fetch starter data from the API. Replace placeholders with your tenant, region, and access token.

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/assistants/{assistantId}/starters/{starterId}" \
-H "Authorization: Bearer <access_token>"

```

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

### Example Response for Get Space Share

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

An example JSON response structure for a successful retrieval of space share information.

```json
{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "disabled": true,
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceName": "string",
  "resourceType": "app"
}
```

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

### Start Local Web Server (Python)

Source: https://qlik.dev/embed/qlik-embed/qlik-embed-webcomponent-quickstart

Start a local web server using Python to serve your HTML files. This is necessary for testing the embedded Qlik components.

```bash
python -m http.server 8080

```

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

### Complete Basic KPI Example with Visualization API

Source: https://qlik.dev/embed/capability-api/customize/visualizations/create-kpi.md

This complete JavaScript example demonstrates how to initialize the Qlik API, open an app, and create a KPI visualization with a defined measure and specific styling. Ensure you replace placeholders like '<TENANT_URL>', '<WEB_INTEGRATION_ID>', and '<APP_ID>' with your actual values.

```javascript
const config = {
  host: '<TENANT_URL>', //for example, 'abc.us.example.com'
  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));
  const app = qlik.openApp('<APP_ID>', config);
  app.visualization.create(
    'kpi',
    [
      {
        "qDef": {
          "qLabel": "GIR %",
          "qDef": "Avg(GIR)",
          "qNumFormat": {
            "qType": "F",
            "qnDec": 2,
            "qUseThou": 0,
            "qFmt": "0.0%",
            "qDec": ".",
            "qThou": ","
          }
        }
      }
    ],
    {
      "showTitles": false,
      "showMeasureTitle": true,
      "textAlign": "center",
      "fontSize": "L"
    }
  ).then((vis)=>{
    vis.show("QV01");
  });
});
```

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

### GetFieldsResourceIds Request Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

Example of a JSON-RPC request to get field resource IDs for a given handle and field names.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetFieldsResourceIds",
  "params": {
    "qFieldNames": [
      "value"
    ]
  }
}
```

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

### Example Response for Get API Conditions Settings

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

An example JSON response when successfully retrieving API conditions settings.

```json
{
  "tenantId": "cgdsAumGmQ6l0Bi7CUKt9V8P_Y9GL0sC",
  "enable-conditions": true
}

```

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

### Complete Basic Bar Chart Example

Source: https://qlik.dev/embed/capability-api/customize/visualizations/create-barchart.md

A full example demonstrating how to initialize Qlik, open an app, and create a basic bar chart with specified dimensions, measures, and title options. This code requires configuration for host, port, and app ID.

```javascript
const config = {
 host: '<TENANT_URL>', //for example, 'abc.us.example.com'
 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));
 const app = qlik.openApp('<APP_ID>', config);
 app.visualization.create(
  'barchart',
  [
   "NetScoreName",
   "=Count(NetScoreName)"
  ],
  {
   "showTitles": true,
   "title": "Net scores"
  }
 ).then((vis)=>{
  vis.show("QV01");
 });
});
```

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

### Example Response for Get Data Source Settings

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

This is an example of the JSON response structure when retrieving data source settings.

```json
{
  "disabled": false
}

```

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

### Example of setting app objects

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

This example demonstrates how to use the 'qlik app object set' command with a glob pattern to specify the JSON files containing the objects to be set or updated.

```bash
qlik app object set ./my-objects-glob-path.json
```

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

### Start Task

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

Initiates the execution of a specified task. This operation is asynchronous, and the API provides examples for initiating the start action.

```APIDOC
## POST /api/v1/tasks/{id}/actions/start

### Description
Starts the execution of a specified task.

### Method
POST

### Endpoint
/api/v1/tasks/{id}/actions/start

### Parameters
#### Path Parameters
- **id** (string) - Yes - The task's unique identifier.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates that the task started successfully.

#### Response Example
```json
{
  "message": "Task started successfully"
}
```
```

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

### Create Web Integration with Options

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

Demonstrates creating a web integration with various command-line options, including name, valid origins, and retry settings.

```bash
qlik web-integration create --name "AnotherIntegration" --validOrigins "https://example.com" --retry 5 --interval 5
```

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

### Get Media List Response Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

Example JSON-RPC response payload for the GetMediaList method, detailing available media files.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qList": {
      "qItems": [
        {
          "qUrlDef": "value",
          "qUrl": "value"
        }
      ]
    },
    "qReturn": true
  }
}

```

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

### Start Development Server

Source: https://qlik.dev/embed/qlik-embed/quickstart/qlik-embed-svelte-quickstart.md

Run the development server to see your embedded Qlik visualization. Ensure your OAuth client configuration and `redirectUri` in the code match the port Vite is running on.

```bash
npm run dev
```

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

### Example: Use Local Engine Context

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

This example demonstrates how to activate a context named 'local-engine'. Ensure this context is pre-configured in your Qlik CLI settings.

```bash
qlik context use local-engine
```

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

### Example Response for Get Condition

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

This is an example of a successful JSON response when retrieving condition data, showing both dataCondition and compoundCondition details.

```json
{
  "type": "compound",
  "ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
  "tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
  "dataCondition": {
    "headers": [
      "sumnum"
    ],
    "history": {
      "enabled": true
    },
    "measures": [
      {
        "title": "sumnum",
        "qLibraryId": "PgQKNQ",
        "qNumFormat": {
          "qDec": ".",
          "qFmt": "###0",
          "qType": "I",
          "qnDec": 0,
          "qUseThou": 1
        }
      }
    ],
    "dimensions": [
      {
        "field": "Neighborhood",
        "title": "Neighborhood",
        "qLibraryId": "PgQKNQ"
      }
    ],
    "selections": [
      {
        "count": 2,
        "field": "SalesTerritoryCountry",
        "selectedSummary": "[ Germany, Australia ]"
      }
    ],
    "conditionBase": {
      "id": "5f31c6e8476ae50001030fb6",
      "type": "compound",
      "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
      "created": "2006-01-02T15:04:05Z07:00",
      "ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
      "updated": "2006-01-02T14:04:05Z07:00",
      "tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
      "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
      "createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
      "description": "My condition",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    },
    "conditionData": {}
  },
  "compoundCondition": {
    "data": {
      "history": {
        "enabled": true
      },
      "conditions": [
        "rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
        "qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
        "4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
        "ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
      ],
      "expression": "($0 OR $1) AND ($2 OR $3)"
    },
    "conditionBase": {
      "id": "5f31c6e8476ae50001030fb6",
      "type": "compound",
      "appId": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
      "created": "2006-01-02T15:04:05Z07:00",
      "ownerId": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
      "updated": "2006-01-02T14:04:05Z07:00",
      "tenantId": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
      "bookmarkId": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
      "createdById": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
      "description": "My condition",
      "lastReloadTime": "2006-01-02T15:04:05Z07:00"
    }
  }
}

```

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

### Initialize Qlik Cloud Context with API Key

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

Guides through setting up a Qlik Cloud context using an API key. This method allows running calls under your personal user account.

```bash
$ qlik context init
Acquiring access to Qlik Cloud

Specify your tenant URL, usually in the form: https://<tenant>.<region>.qlikcloud.com
Where <tenant> is the name of the tenant and <region> is eu, us, ap, etc...
Enter tenant url: https://<tenant>.<region>.qlikcloud.com
Specify what type of authentication that should be used i.e API-Key (A) or OAuth (O). Default is API-Key (A).
A/O?: A

To complete this setup you have to have the 'developer' role and have
API-keys enabled. If you're unsure, you can ask your tenant-admin.
To generate a new API-key, go to https://mytenant.eu.qlikcloud.com/settings/api-keys

API-key: <my-api-key>
```

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

### cURL for GET Brand File

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

Example using cURL to make a GET request for a brand file. Includes authorization header.

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-H "Authorization: Bearer <access_token>"

```

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

### Example Response for Create Assistant Starter

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

This is an example JSON response when creating an assistant starter, showing the structure of the returned starter object.

```json
{
  "id": "507f191e810c19729de860ea",
  "question": "Where was Genghis Khan buried?",
  "createdAt": "2021-10-02T14:20:50.52Z",
  "followups": [
    {
      "id": "507f191e810c19729de860ea",
      "question": "Where was Genghis Khan buried?",
      "additionalContext": "string",
      "recommendedAnswer": {
        "content": "string",
        "contentType": "text | markdown | html"
      }
    }
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "additionalContext": "string",
  "recommendedAnswer": {
    "content": "string",
    "contentType": "text | markdown | html"
  }
}

```

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

### GET /api/v1/tenant-settings/start-pages

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

Retrieves start pages for the tenant settings.

```APIDOC
## GET /api/v1/tenant-settings/start-pages

### Description
Retrieves start pages for the tenant settings.

### Method
GET

### Endpoint
/api/v1/tenant-settings/start-pages
```

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

### Synopsis for qlik task start

Source: https://qlik.dev/toolkits/qlik-cli/task/task-start.md

This is the basic command structure for starting a task. Replace <taskId> with the actual ID of the task you want to start.

```bash
qlik task start <taskId> [flags]
```

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

### Get Object Response Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

Example JSON-RPC response payload for the GetObject method, returning object properties like type and handle.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qReturn": {
      "qType": "value",
      "qHandle": 123,
      "qGenericType": "value",
      "qGenericId": "value"
    }
  }
}

```

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

### Create Glossary using Qlik CLI

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

This command-line interface example shows how to create a glossary using the Qlik CLI. All required parameters are included.

```bash
qlik glossary create \
--description="This glossary contains definitions and concepts of business terms." \
--name="Organization wide glossary" \
--overview="[{"type":"paragraph","children":[{"text":"This glossary contains business terms"}]}]" \
--spaceId="507f191e810c19729de860ea" \
--tags='"Red","Sales"' \
--termTemplate-relatedInformation="[{"type":"paragraph","children":[{"text":""}]}]"

```

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

### GetFileTableFields Request Example

Source: https://qlik.dev/apis/json-rpc/qix/doc

Example of a JSON-RPC request to get file table fields, including detailed data format parameters for CSV.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetFileTableFields",
  "params": {
    "qConnectionId": "value",
    "qRelativePath": "value",
    "qDataFormat": {
      "qType": "CSV",
      "qLabel": "value",
      "qQuote": "value",
      "qComment": "value",
      "qDelimiter": {
        "qName": "value",
        "qScriptCode": "value",
        "qNumber": 123,
        "qIsMultiple": true
      },
      "qCodePage": 123,
      "qHeaderSize": 123,
      "qRecordSize": 123,
      "qTabSize": 123,
      "qIgnoreEOF": true,
      "qFixedWidthDelimiters": "value"
    },
    "qTable": "value"
  }
}
```

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

### Example Response for Get Item Settings

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

This is an example of a successful JSON response when retrieving item settings, indicating the status of usage metrics.

```json
{
  "usageMetricsEnabled": true
}

```

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

### Complete Code Example: Basic Histogram

Source: https://qlik.dev/embed/capability-api/customize/visualizations/create-histogram.md

A full example demonstrating how to initialize Qlik, open an app, and create a basic histogram with a specified dimension and title. Ensure you replace placeholders like '<TENANT_URL>', '<WEB_INTEGRATION_ID>', and '<APP_ID>'.

```javascript
const config = {
  host: '<TENANT_URL>', //for example, 'abc.us.example.com'
  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));
  const app = qlik.openApp('<APP_ID>', config);
  app.visualization.create(
    'histogram',
    [
      {
        "qDef": {
          "qFieldDefs": [
            "DrDist"
          ],
          "qFieldLabels": [
            "Drive distance"
          ]
        }
      }
    ],
    {
      "showTitles": true,
      "title": "Driving distance"
    }
  ).then((vis)=>{
    vis.show("QV01");
  });
});
```