Machine Learning

The Machine Learning API allows you to generate profile insights to analyze datasets, create and manage machine learning experiments, deploy models, and run predictions.

Download OpenAPI spec

Endpoints

GET

/api/v1/ml/deployments
POST

/api/v1/ml/deployments
GET

/api/v1/ml/deployments/{deploymentId}
PATCH

/api/v1/ml/deployments/{deploymentId}
DELETE

/api/v1/ml/deployments/{deploymentId}
POST

/api/v1/ml/deployments/{deploymentId}/actions/activate-models
POST

/api/v1/ml/deployments/{deploymentId}/actions/deactivate-models
GET

/api/v1/ml/deployments/{deploymentId}/aliases
POST

/api/v1/ml/deployments/{deploymentId}/aliases
GET

/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}
PATCH

/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}
DELETE

/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}
POST

/api/v1/ml/deployments/{deploymentId}/aliases/{aliasName}/realtime-predictions/actions/run
GET

/api/v1/ml/deployments/{deploymentId}/batch-predictions
POST

/api/v1/ml/deployments/{deploymentId}/batch-predictions
GET

/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
PATCH

/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
DELETE

/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
POST

/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict
GET

/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
PATCH

/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
PUT

/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
DELETE

/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
POST

/api/v1/ml/deployments/{deploymentId}/models/actions/add
POST

/api/v1/ml/deployments/{deploymentId}/models/actions/remove
POST

/api/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run
GET

/api/v1/ml/experiments
POST

/api/v1/ml/experiments
GET

/api/v1/ml/experiments/{experimentId}
PATCH

/api/v1/ml/experiments/{experimentId}
DELETE

/api/v1/ml/experiments/{experimentId}
POST

/api/v1/ml/experiments/{experimentId}/actions/recommend-models
GET

/api/v1/ml/experiments/{experimentId}/models
GET

/api/v1/ml/experiments/{experimentId}/models/{modelId}
GET

/api/v1/ml/experiments/{experimentId}/versions
POST

/api/v1/ml/experiments/{experimentId}/versions
GET

/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}
PATCH

/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}
DELETE

/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}
POST

/api/v1/ml/jobs/{corrType}/{corrId}/actions/cancel
POST

/api/v1/ml/profile-insights
GET

/api/v1/ml/profile-insights/{dataSetId}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filter string
Deployment fields by which you can filter responses.
- spaceId ID string (or empty string for personal space) - ID of space in which deployment(s) exist
- modelId UUID string - By model ID
- createdBy ID string
- ownerId ID string
- experimentId UUID string - ID of experiment in which model(s) exist
- experimentVersionId UUID string - ID of experiment version in which model(s) exist
- predictionId UUID string - ID of prediction which exists on deployment
- predictionEnabled boolean - Are predictions enabled
- exactName string - Deployments with exact name. Names may not be unique.
- nameContains string - Deployments where name includes this. Names may not be unique
- experimentType string - Deployments that have models of the experiment type
sort string

Field(s) by which to sort response

Can be one of: "createdAt""+createdAt""-createdAt""name""+name""-name""updatedAt""+updatedAt""-updatedAt"
limit integer

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offset integer

Number of rows to skip before getting page[size]

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "deployment"
  
  attributes object
  
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  modelId string
  
  Required Filterable
  
  ID of the model currently assigned to the default alias.
  
  format = "uuid"
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  createdBy string
  
  Required Filterable
  
  ID of the owner/user that created this entity.
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  deprecated boolean
  
  Required
  
  Whether this deployment is deprecated
  
  description string
  
  Required
  
  Description of this entity
  
  errorMessage string
  
  JSON string of error object
  
  deployedModelIds array of strings
  
  IDs of all models deployed to the deployment
  
  enablePredictions boolean
  
  Required Filterable
  
  Whether to allow predictions
- meta object
  
  Meta for FIND operations
  
  Show meta properties
  
  count integer
  
  Required
- links object
  
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  last object
  
  Required
  
  Show last properties
  
  href string
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  Link to the next set of responses
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  Link to the previous set of responses
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Link to the current set of responses
  
  format = "uri"
  
  first object
  
  Required
  
  Show first properties
  
  href string
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/deployments

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlDeployments({})

qlik ml deployment ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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"
    }
  }
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

application/json object

Input for creating a new deployment
Show application/json properties
- data object
  
  Show data properties
  
  type string
  
  Can be one of: "deployment"
  default = "deployment"
  
  attributes object
  
  Show attributes properties
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  modelId string
  
  Required Filterable
  
  ID of the model
  
  format = "uuid"
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  deprecated boolean
  
  Whether this deployment is deprecated
  
  description string
  
  Description of this entity
  
  enablePredictions boolean
  
  Whether to allow real-time predictions

Responses

201

Created

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "deployment"
  
  attributes object
  
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  modelId string
  
  Required Filterable
  
  ID of the model currently assigned to the default alias.
  
  format = "uuid"
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  createdBy string
  
  Required Filterable
  
  ID of the owner/user that created this entity.
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  deprecated boolean
  
  Required
  
  Whether this deployment is deprecated
  
  description string
  
  Required
  
  Description of this entity
  
  errorMessage string
  
  JSON string of error object
  
  deployedModelIds array of strings
  
  IDs of all models deployed to the deployment
  
  enablePredictions boolean
  
  Required Filterable
  
  Whether to allow predictions

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.createMlDeployment({
  data: {
    attributes: {
      deprecated: true,
      description: 'string',
      enablePredictions: true,
      modelId:
        'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
      name: 'string',
      spaceId: 'string',
    },
    type: 'deployment',
  },
})

qlik ml deployment create \
  --data-attributes-modelId 'c35f4b70-3ce4-4a30-b62b-2aef16943bc4' \
  --data-attributes-name 'string' \
  --data-attributes-spaceId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"deployment","attributes":{"name":"string","modelId":"c35f4b70-3ce4-4a30-b62b-2aef16943bc4","spaceId":"string","deprecated":true,"description":"string","enablePredictions":true}}}'

Example Response

{
  "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
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "deployment"
  
  attributes object
  
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  modelId string
  
  Required Filterable
  
  ID of the model currently assigned to the default alias.
  
  format = "uuid"
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  createdBy string
  
  Required Filterable
  
  ID of the owner/user that created this entity.
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  deprecated boolean
  
  Required
  
  Whether this deployment is deprecated
  
  description string
  
  Required
  
  Description of this entity
  
  errorMessage string
  
  JSON string of error object
  
  deployedModelIds array of strings
  
  IDs of all models deployed to the deployment
  
  enablePredictions boolean
  
  Required Filterable
  
  Whether to allow predictions

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/deployments/{deploymentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlDeployment('string')

qlik ml deployment get 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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
    }
  }
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Request Body

application/json array of objects

Values that can be patched.
Show application/json properties
- op string
  
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- path string
  
  Required
  
  Path for the property you want to update
  
  Can be one of: "/name""/description""/spaceId"
- value any
  
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

PATCH /api/v1/ml/deployments/{deploymentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.patchMlDeployment('string', [
  {
    op: 'replace',
    path: '/name',
    value: 'New Name',
  },
])

qlik ml deployment patch 'string' \
  --op 'replace' \
  --path '/name' \
  --value New Name

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"New Name"}]'

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

DELETE /api/v1/ml/deployments/{deploymentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.deleteMlDeployment('string')

qlik ml deployment rm 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Activates the deployed model on this deployment's default alias. The response reports which model was targeted and whether its state actually changed via the qlik-model-id and qlik-state-change response headers. If the model was already active, the request still succeeds but qlik-state-change is NO_CHANGE.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/actions/activate-models

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.activateModelsMlDeployment('string')

qlik ml deployment activate-models 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/actions/activate-models" \
-X POST \
-H "Authorization: Bearer <access_token>"

Deactivates the deployed model on this deployment's default alias. The response reports which model was targeted and whether its state actually changed via the qlik-model-id and qlik-state-change response headers. If the model was already inactive, the request still succeeds but qlik-state-change is NO_CHANGE.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/actions/deactivate-models

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.deactivateModelsMlDeployment(
  'string',
)

qlik ml deployment deactivate-models 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/actions/deactivate-models" \
-X POST \
-H "Authorization: Bearer <access_token>"

Retrieves a list of aliases based on filter parameters for a deployment.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filter string
Alias fields by which you can filter responses
- name string - Aliases with exact name
- modelId UUID string - By model ID
- mode enum string - Mode by which alias is set to
sort string

Field(s) by which to sort response

Can be one of: "name""+name""-name"
limit integer

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offset integer

Number of rows to skip before getting page[size]

Path Parameters

deploymentId string

Required

ID of the deployment

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "alias"
  
  attributes object
  
  Required
  
  An AutoML alias
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  mode string
  
  Required
  
  The mode of an alias. Default mode means the model assigned to that alias will be used if alias is not specified
  
  Can be one of: "default""undefined"
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  models array of objects
  
  Required
  
  Model information stored on an alias
  
  Show models properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  createdBy string
  
  Required
  
  ID of the owner/user that created this entity
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  deploymentId string
  
  Required Filterable
  
  ID of a model deployment
  
  format = "uuid"
- meta object
  
  Meta for FIND operations
  
  Show meta properties
  
  count integer
  
  Required
- links object
  
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  last object
  
  Required
  
  Show last properties
  
  href string
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  Link to the next set of responses
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  Link to the previous set of responses
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Link to the current set of responses
  
  format = "uri"
  
  first object
  
  Required
  
  Show first properties
  
  href string
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/deployments/{deploymentId}/aliases

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlDeploymentAliases('string', {})

qlik ml deployment alias ls \
  --deploymentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/aliases" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "type": "alias",
      "attributes": {
        "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "mode": "default",
        "name": "string",
        "models": [
          {
            "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
          }
        ],
        "createdAt": "string",
        "createdBy": "string",
        "updatedAt": "string",
        "deploymentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
      }
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  }
}

Creates an alias for a deployment.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Request Body

application/json object

Input for creating a new alias
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  type string
  
  Required
  
  Can be one of: "alias"
  default = "alias"
  
  attributes object
  
  Required
  
  Show attributes properties
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  models array of objects
  
  Required
  
  Model information stored on an alias
  
  Show models properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"

Responses

201

Created

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "alias"
  
  attributes object
  
  Required
  
  An AutoML alias
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  mode string
  
  Required
  
  The mode of an alias. Default mode means the model assigned to that alias will be used if alias is not specified
  
  Can be one of: "default""undefined"
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  models array of objects
  
  Required
  
  Model information stored on an alias
  
  Show models properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  createdBy string
  
  Required
  
  ID of the owner/user that created this entity
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  deploymentId string
  
  Required Filterable
  
  ID of a model deployment
  
  format = "uuid"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/aliases

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.createMlDeploymentAliase('string', {
  data: {
    attributes: {
      models: [
        {
          id: 'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
        },
      ],
      name: 'string',
    },
    type: 'alias',
  },
})

qlik ml deployment alias create \
  --deploymentId 'string' \
  --data-attributes-models-id '' \
  --data-attributes-name 'string' \
  --data-type 'alias'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/aliases" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"alias","attributes":{"name":"string","models":[{"id":"c35f4b70-3ce4-4a30-b62b-2aef16943bc4"}]}}}'

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "alias",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "mode": "default",
      "name": "string",
      "models": [
        {
          "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
        }
      ],
      "createdAt": "string",
      "createdBy": "string",
      "updatedAt": "string",
      "deploymentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
    }
  }
}

Retrieves an alias that exists on the deployment.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
aliasId string

Required

ID of the alias

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "alias"
  
  attributes object
  
  Required
  
  An AutoML alias
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  mode string
  
  Required
  
  The mode of an alias. Default mode means the model assigned to that alias will be used if alias is not specified
  
  Can be one of: "default""undefined"
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  models array of objects
  
  Required
  
  Model information stored on an alias
  
  Show models properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  createdBy string
  
  Required
  
  ID of the owner/user that created this entity
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  deploymentId string
  
  Required Filterable
  
  ID of a model deployment
  
  format = "uuid"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlDeploymentAliase(
  'string',
  'string',
)

qlik ml deployment alias get 'string' \
  --deploymentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "alias",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "mode": "default",
      "name": "string",
      "models": [
        {
          "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
        }
      ],
      "createdAt": "string",
      "createdBy": "string",
      "updatedAt": "string",
      "deploymentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
    }
  }
}

Updates an alias for a deployment.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
aliasId string

Required

ID of the alias

Request Body

application/json array of objects

Alias values that can be patched.
Show application/json properties
- op string
  
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- path string
  
  Required
  
  Path for the property you want to update
  
  Can be one of: "/name""/models"
- value any
  
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

PATCH /api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.patchMlDeploymentAliase(
  'string',
  'string',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'New Name',
    },

    {
      op: 'replace',
      path: '/models',
      value: 'modelId',
    },
  ],
)

qlik ml deployment alias patch 'string' \
  --deploymentId 'string' \
  --op 'replace' \
  --path '/name' \
  --value New Name

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"New Name"},{"op":"replace","path":"/models","value":"modelId"}]'

Delete an alias from a deployment.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
aliasId string

Required

ID of the alias

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

DELETE /api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.deleteMlDeploymentAliase(
  'string',
  'string',
)

qlik ml deployment alias rm 'string' \
  --deploymentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Facts

Rate limit

Tier 2 (100 requests per minute)

Query Parameters

includeNotPredictedReason boolean

If true, reason why a prediction was not produced included response
includeShap boolean

If true, shap values included in response
includeSource boolean

If true, source data included in response
index string

The name of the feature in the source data to use as an index in the response data. The column will be included with its original name and values. This is intended to allow the caller to join results with source data.

Path Parameters

deploymentId string

Required

ID of the deployment
aliasName string

Required

The name of the ML Deployment Alias that will be used to determine which model should be used to produce predictions

Request Body

Request payload containing the dataset for predictions. Date features must be in ISO 8601 format.

application/json object

Input values for creating realtime predictions
Show application/json properties
- rows array of arrays
  
  Rows of the dataset from which to produce predictions. Date features must be in ISO 8601 format.
- schema array of objects
  
  List of features in the dataset.
  
  Show schema properties
  
  name string
  
  The name of a feature in the dataset

Responses

200

Stream of combined prediction output returned successfully.

application/json object

Input values for creating realtime predictions
Show application/json properties
- data object
  
  Show data properties
  
  type string
  
  Can be one of: "realtime-prediction"
  default = "realtime-prediction"
  
  attributes object
  
  Show attributes properties
  
  rows array of arrays
  
  Rows of the dataset from which to produce predictions
  
  schema array of objects
  
  List of features in the dataset
  
  Show schema properties
  
  name string
  
  The name of a feature in the dataset

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

409

Conflict

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/aliases/{aliasName}/realtime-predictions/actions/run

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.runMlDeploymentAliaseRealtimePredictions(
  'string',
  'string',
  {},
  {
    rows: [['string']],
    schema: [{ name: 'string' }],
  },
)

qlik ml deployment alias realtime-prediction \
  --deploymentId 'string' \
  --aliasName 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/aliases/{aliasName}/realtime-predictions/actions/run" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"rows":[["string"]],"schema":[{"name":"string"}]}'

Example Response

{
  "data": {
    "type": "realtime-prediction",
    "attributes": {
      "rows": [
        [
          "string"
        ]
      ],
      "schema": [
        {
          "name": "string"
        }
      ]
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filter string
Batch prediction fields by which you can filter responses.
- aliasId UUID string - ID of an alias within the batch prediction
- createdBy ID string
- deploymentId UUID string - ID of a deployment of a model associated with the experiment
- experimentId UUID string - ID of experiment in which model(s) exist
- experimentVersionId UUID string - ID of experiment version in which model(s) exist
- modelId UUID string - By model ID
- ownerId ID string of batch prediction owner
sort string

Field(s) by which to sort response

Can be one of: "createdAt""+createdAt""-createdAt""description""+description""-description""name""+name""-name""updatedAt""+updatedAt""-updatedAt"
limit integer

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offset integer

Number of rows to skip before getting page[size]

Path Parameters

deploymentId string

Required

ID of the deployment

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "batch-prediction"
  
  attributes object
  
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  status string
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  aliasId string
  
  ID of an alias
  
  format = "uuid"
  
  ownerId string
  
  Filterable
  
  ID of owner/user for this entity
  
  schedule object
  
  Batch prediction job schedule
  
  Show schedule properties
  
  status string
  
  The status of the schedule
  
  Can be one of: "pending""active""error""error_scheduler_unreachable""error_scheduler_callback_error""licence_advanced_features_required""failing_schedule_permission"
  
  timezone string
  
  Timezone used for the date-time fields
  
  recurrence array of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTime string
  
  When the job finished
  
  chronosJobId string
  
  The ID of the chronos job
  
  startDateTime string
  
  When the job is scheduled to start
  
  failureAttempts number
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnly boolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  lastSuccessfulDateTime string
  
  When the last successful job happened
  
  createdAt string
  
  Timestamp when this was created
  
  createdBy string
  
  ID of the owner/user that ran this prediction batch
  
  dataSetId string
  
  The Qlik catalog dataset ID
  
  datasetId string
  
  ID of the dataset with the prediction results
  
  updatedAt string
  
  Timestamp when this was updated
  
  writeback object
  
  Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog.
  
  Note that for predictions based on time series models, dstShapName and dstCoordShapName do not apply and will be ignored if set.
  
  Show writeback properties
  
  format string
  
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  default = "parquet"
  
  dstName string
  
  Required
  
  spaceId string
  
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapName string
  
  dstSourceName string
  
  dstCoordShapName string
  
  dstNotPredictedName string
  
  indexColumn string
  
  A optional column name upon which to create an index. Must be unique for every row. If not included, Qlik will create a unique index column.
  
  deploymentId string
  
  Filterable
  
  ID of a model deployment
  
  format = "uuid"
  
  errorMessage string
  
  JSON string of error object
  
  outputDataset string
  
  Where to output dataset
- meta object
  
  Meta for FIND operations
  
  Show meta properties
  
  count integer
  
  Required
- links object
  
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  last object
  
  Required
  
  Show last properties
  
  href string
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  Link to the next set of responses
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  Link to the previous set of responses
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Link to the current set of responses
  
  format = "uri"
  
  first object
  
  Required
  
  Show first properties
  
  href string
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/deployments/{deploymentId}/batch-predictions

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlDeploymentBatchPredictions(
  'string',
  {},
)

qlik ml deployment batch-prediction ls \
  --deploymentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "type": "batch-prediction",
      "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",
        "status": "modified",
        "aliasId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "ownerId": "string",
        "schedule": {
          "status": "pending",
          "timezone": "America/Toronto",
          "recurrence": [
            [
              "Daily at 11:10:00 AM [\"RRULE:FREQ=DAILY;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]",
              "Weekly on Mondays at 11:10:00 AM [\"RRULE:FREQ=WEEKLY;INTERVAL:1;BYDAY=MO;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]"
            ]
          ],
          "endDateTime": "string",
          "chronosJobId": "string",
          "startDateTime": "string",
          "failureAttempts": 42,
          "applyDatasetChangeOnly": true,
          "lastSuccessfulDateTime": "string"
        },
        "createdAt": "string",
        "createdBy": "string",
        "dataSetId": "672e55cfcadfb8a18281523e",
        "datasetId": "string",
        "updatedAt": "string",
        "writeback": {
          "format": "parquet",
          "dstName": "string",
          "spaceId": "string",
          "dstShapName": "string",
          "dstSourceName": "string",
          "dstCoordShapName": "string",
          "dstNotPredictedName": "string"
        },
        "indexColumn": "string",
        "deploymentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "errorMessage": "string",
        "outputDataset": "string"
      }
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  }
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Request Body

application/json object

Input values for creating a batch prediction configuration
Show application/json properties
- data object
  
  Show data properties
  
  type string
  
  Can be one of: "batch-prediction"
  default = "batch-prediction"
  
  attributes object
  
  Show attributes properties
  
  name string
  
  Filterable
  
  Name of this entity
  
  aliasId string
  
  ID of an alias
  
  format = "uuid"
  
  schedule object
  
  Configuration to schedule a batch prediction
  
  Show schedule properties
  
  timezone string
  
  Required
  
  Timezone used for the date-time fields
  
  recurrence array of strings
  
  Required
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTime string
  
  When the job is scheduled to finish, date needs to be now or in future
  
  startDateTime string
  
  Required
  
  When the job is scheduled to start, date needs to be now or in future
  
  applyDatasetChangeOnly boolean
  
  Required
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  dataSetId string
  
  The Qlik catalog dataset ID
  
  writeback object
  
  Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog.
  
  Note that for predictions based on time series models, dstShapName and dstCoordShapName do not apply and will be ignored if set.
  
  Show writeback properties
  
  format string
  
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  default = "parquet"
  
  dstName string
  
  Required
  
  spaceId string
  
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapName string
  
  dstSourceName string
  
  dstCoordShapName string
  
  dstNotPredictedName string
  
  description string
  
  indexColumn string
  
  A optional column name upon which to create an index. Must be unique for every row. If not included, Qlik will create a unique index column.
  
  deploymentId string
  
  Filterable
  
  ID of a model deployment
  
  format = "uuid"

Responses

201

Created

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "batch-prediction"
  
  attributes object
  
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  status string
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  aliasId string
  
  ID of an alias
  
  format = "uuid"
  
  ownerId string
  
  Filterable
  
  ID of owner/user for this entity
  
  schedule object
  
  Batch prediction job schedule
  
  Show schedule properties
  
  status string
  
  The status of the schedule
  
  Can be one of: "pending""active""error""error_scheduler_unreachable""error_scheduler_callback_error""licence_advanced_features_required""failing_schedule_permission"
  
  timezone string
  
  Timezone used for the date-time fields
  
  recurrence array of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTime string
  
  When the job finished
  
  chronosJobId string
  
  The ID of the chronos job
  
  startDateTime string
  
  When the job is scheduled to start
  
  failureAttempts number
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnly boolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  lastSuccessfulDateTime string
  
  When the last successful job happened
  
  createdAt string
  
  Timestamp when this was created
  
  createdBy string
  
  ID of the owner/user that ran this prediction batch
  
  dataSetId string
  
  The Qlik catalog dataset ID
  
  datasetId string
  
  ID of the dataset with the prediction results
  
  updatedAt string
  
  Timestamp when this was updated
  
  writeback object
  
  Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog.
  
  Note that for predictions based on time series models, dstShapName and dstCoordShapName do not apply and will be ignored if set.
  
  Show writeback properties
  
  format string
  
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  default = "parquet"
  
  dstName string
  
  Required
  
  spaceId string
  
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapName string
  
  dstSourceName string
  
  dstCoordShapName string
  
  dstNotPredictedName string
  
  indexColumn string
  
  A optional column name upon which to create an index. Must be unique for every row. If not included, Qlik will create a unique index column.
  
  deploymentId string
  
  Filterable
  
  ID of a model deployment
  
  format = "uuid"
  
  errorMessage string
  
  JSON string of error object
  
  outputDataset string
  
  Where to output dataset

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/batch-predictions

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.createMlDeploymentBatchPrediction(
  'string',
  {
    data: {
      attributes: {
        aliasId:
          'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
        dataSetId: '672e55cfcadfb8a18281523e',
        deploymentId:
          'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
        description: 'string',
        indexColumn: 'string',
        name: 'string',
        schedule: {
          applyDatasetChangeOnly: true,
          endDateTime: '2035-12-31T23:59:00',
          recurrence: [
            'RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=16;BYMINUTE=30;BYSECOND=0',
          ],
          startDateTime: '2035-12-25T00:00:00',
          timezone: 'America/Toronto',
        },
        writeback: {
          dstCoordShapName: 'string',
          dstName: 'string',
          dstNotPredictedName: 'string',
          dstShapName: 'string',
          dstSourceName: 'string',
          format: 'parquet',
          spaceId: 'string',
        },
      },
      type: 'batch-prediction',
    },
  },
)

qlik ml deployment batch-prediction create \
  --deploymentId 'string' \
  --data-attributes-schedule-startDateTime '2035-12-25T00:00:00' \
  --data-attributes-schedule-timezone 'America/Toronto' \
  --data-attributes-writeback-dstName 'string' \
  --data-attributes-writeback-format 'parquet' \
  --data-attributes-writeback-spaceId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"batch-prediction","attributes":{"name":"string","aliasId":"c35f4b70-3ce4-4a30-b62b-2aef16943bc4","schedule":{"timezone":"America/Toronto","recurrence":["RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=16;BYMINUTE=30;BYSECOND=0"],"endDateTime":"2035-12-31T23:59:00","startDateTime":"2035-12-25T00:00:00","applyDatasetChangeOnly":true},"dataSetId":"672e55cfcadfb8a18281523e","writeback":{"format":"parquet","dstName":"string","spaceId":"string","dstShapName":"string","dstSourceName":"string","dstCoordShapName":"string","dstNotPredictedName":"string"},"description":"string","indexColumn":"string","deploymentId":"c35f4b70-3ce4-4a30-b62b-2aef16943bc4"}}}'

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "batch-prediction",
    "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",
      "status": "modified",
      "aliasId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "ownerId": "string",
      "schedule": {
        "status": "pending",
        "timezone": "America/Toronto",
        "recurrence": [
          [
            "Daily at 11:10:00 AM [\"RRULE:FREQ=DAILY;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]",
            "Weekly on Mondays at 11:10:00 AM [\"RRULE:FREQ=WEEKLY;INTERVAL:1;BYDAY=MO;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]"
          ]
        ],
        "endDateTime": "string",
        "chronosJobId": "string",
        "startDateTime": "string",
        "failureAttempts": 42,
        "applyDatasetChangeOnly": true,
        "lastSuccessfulDateTime": "string"
      },
      "createdAt": "string",
      "createdBy": "string",
      "dataSetId": "672e55cfcadfb8a18281523e",
      "datasetId": "string",
      "updatedAt": "string",
      "writeback": {
        "format": "parquet",
        "dstName": "string",
        "spaceId": "string",
        "dstShapName": "string",
        "dstSourceName": "string",
        "dstCoordShapName": "string",
        "dstNotPredictedName": "string"
      },
      "indexColumn": "string",
      "deploymentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "errorMessage": "string",
      "outputDataset": "string"
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
batchPredictionId string

Required

ID of the batch prediction

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "batch-prediction"
  
  attributes object
  
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  status string
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  aliasId string
  
  ID of an alias
  
  format = "uuid"
  
  ownerId string
  
  Filterable
  
  ID of owner/user for this entity
  
  schedule object
  
  Batch prediction job schedule
  
  Show schedule properties
  
  status string
  
  The status of the schedule
  
  Can be one of: "pending""active""error""error_scheduler_unreachable""error_scheduler_callback_error""licence_advanced_features_required""failing_schedule_permission"
  
  timezone string
  
  Timezone used for the date-time fields
  
  recurrence array of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTime string
  
  When the job finished
  
  chronosJobId string
  
  The ID of the chronos job
  
  startDateTime string
  
  When the job is scheduled to start
  
  failureAttempts number
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnly boolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  lastSuccessfulDateTime string
  
  When the last successful job happened
  
  createdAt string
  
  Timestamp when this was created
  
  createdBy string
  
  ID of the owner/user that ran this prediction batch
  
  dataSetId string
  
  The Qlik catalog dataset ID
  
  datasetId string
  
  ID of the dataset with the prediction results
  
  updatedAt string
  
  Timestamp when this was updated
  
  writeback object
  
  Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog.
  
  Note that for predictions based on time series models, dstShapName and dstCoordShapName do not apply and will be ignored if set.
  
  Show writeback properties
  
  format string
  
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  default = "parquet"
  
  dstName string
  
  Required
  
  spaceId string
  
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapName string
  
  dstSourceName string
  
  dstCoordShapName string
  
  dstNotPredictedName string
  
  indexColumn string
  
  A optional column name upon which to create an index. Must be unique for every row. If not included, Qlik will create a unique index column.
  
  deploymentId string
  
  Filterable
  
  ID of a model deployment
  
  format = "uuid"
  
  errorMessage string
  
  JSON string of error object
  
  outputDataset string
  
  Where to output dataset

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlDeploymentBatchPrediction(
  'string',
  'string',
)

qlik ml deployment batch-prediction get 'string' \
  --deploymentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "batch-prediction",
    "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",
      "status": "modified",
      "aliasId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "ownerId": "string",
      "schedule": {
        "status": "pending",
        "timezone": "America/Toronto",
        "recurrence": [
          [
            "Daily at 11:10:00 AM [\"RRULE:FREQ=DAILY;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]",
            "Weekly on Mondays at 11:10:00 AM [\"RRULE:FREQ=WEEKLY;INTERVAL:1;BYDAY=MO;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]"
          ]
        ],
        "endDateTime": "string",
        "chronosJobId": "string",
        "startDateTime": "string",
        "failureAttempts": 42,
        "applyDatasetChangeOnly": true,
        "lastSuccessfulDateTime": "string"
      },
      "createdAt": "string",
      "createdBy": "string",
      "dataSetId": "672e55cfcadfb8a18281523e",
      "datasetId": "string",
      "updatedAt": "string",
      "writeback": {
        "format": "parquet",
        "dstName": "string",
        "spaceId": "string",
        "dstShapName": "string",
        "dstSourceName": "string",
        "dstCoordShapName": "string",
        "dstNotPredictedName": "string"
      },
      "indexColumn": "string",
      "deploymentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "errorMessage": "string",
      "outputDataset": "string"
    }
  }
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
batchPredictionId string

Required

ID of the batch prediction

Request Body

application/json array of objects
Values that can be patched.
- name: Name of this entity
- description: Description of this entity
- dataSetId
- outputDataset
- indexColumn: Column name upon which to create an index (empty string or undefined will default to automl-generated index)
- applyDatasetChangeOnly
- ownerId: ID of batch owner/user
- writeback: Where to write prediction results
Show application/json properties
- op string
  
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- path string
  
  Required
  
  Path for the property you want to update
  
  Can be one of: "/name""/description""/dataSetId""/indexColumn""/applyDatasetChangeOnly""/ownerId""/writeback/spaceId""/writeback/format""/writeback/dstName""/writeback/dstShapName""/writeback/dstCoordShapName""/writeback/dstNotPredictedName""/writeback/dstSourceName"
- value any
  
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

PATCH /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.patchMlDeploymentBatchPrediction(
  'string',
  'string',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'New Name',
    },
  ],
)

qlik ml deployment batch-prediction patch 'string' \
  --deploymentId 'string' \
  --op 'replace' \
  --path '/name' \
  --value New Name

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"New Name"}]'

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
batchPredictionId string

Required

ID of the batch prediction

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

DELETE /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.deleteMlDeploymentBatchPrediction(
  'string',
  'string',
)

qlik ml deployment batch-prediction rm 'string' \
  --deploymentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
batchPredictionId string

Required

ID of the batch prediction

Responses

202

Accepted

application/json object

Response for batch prediction predict action that indicates job and status
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "job"
  
  attributes object
  
  Required
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Required
  
  corrId string
  
  Required
  
  The ID of a correlated resource of corrType
  
  status string
  
  Required
  
  Status of this job
  
  Can be one of: "pending""completed""cancelled""error""deleted_resource"
  
  details object
  
  Required
  
  Show details properties
  
  isScheduled boolean
  
  Required
  
  outputFiles array of objects
  
  Required
  
  Show outputFiles properties
  
  key string
  
  Required
  
  path string
  
  Required
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  fileName string
  
  Required
  
  fileType string
  
  Required
  
  Dataset file type
  
  lineageSchemaUpdated boolean
  
  jobType string
  
  Required
  
  The type for this job
  
  Can be one of: "prediction"
  
  modelId string
  
  Required Filterable
  
  ID of the model
  
  format = "uuid"
  
  success boolean
  
  Required
  
  trigger string
  
  Required
  
  corrType string
  
  Required
  
  Types names of correlated resources (batch 'prediction' and experiment_version)
  
  Can be one of: "batch-prediction""experiment-version"
  
  tenantId string
  
  Required Filterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  createdBy string
  
  Required
  
  ID of the owner/user that created this entity
  
  deletedAt string
  
  Required
  
  Timestamp when this is deleted
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  parentName string
  
  Required
  
  parentJobId string
  
  ID of the current job's parent
  
  deploymentId string
  
  Required Filterable
  
  ID of a model deployment
  
  format = "uuid"
  
  rowsPredicted number
  
  experimentVersionNumber string

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.predictMlDeploymentBatchPrediction(
  'string',
  'string',
)

qlik ml deployment batch-prediction predict \
  --deploymentId 'string' \
  --batch-predictionId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "job",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "name": "string",
      "corrId": "string",
      "status": "pending",
      "details": {
        "isScheduled": true,
        "outputFiles": [
          {
            "key": "string",
            "path": "string",
            "spaceId": "string",
            "fileName": "string",
            "fileType": "qvd, parquet, csv"
          }
        ],
        "lineageSchemaUpdated": true
      },
      "jobType": "prediction",
      "modelId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "success": true,
      "trigger": "string",
      "corrType": "batch-prediction",
      "tenantId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "createdAt": "string",
      "createdBy": "string",
      "deletedAt": "string",
      "updatedAt": "string",
      "parentName": "string",
      "parentJobId": "string",
      "deploymentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "rowsPredicted": 42,
      "experimentVersionNumber": "string"
    }
  }
}

Retrieves the schedule for a batch prediction.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
batchPredictionId string

Required

ID of the batch prediction

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "batch-prediction-schedule"
  
  attributes object
  
  Required
  
  Batch prediction job schedule
  
  Show attributes properties
  
  status string
  
  The status of the schedule
  
  Can be one of: "pending""active""error""error_scheduler_unreachable""error_scheduler_callback_error""licence_advanced_features_required""failing_schedule_permission"
  
  timezone string
  
  Timezone used for the date-time fields
  
  recurrence array of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTime string
  
  When the job finished
  
  chronosJobId string
  
  The ID of the chronos job
  
  startDateTime string
  
  When the job is scheduled to start
  
  failureAttempts number
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnly boolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  lastSuccessfulDateTime string
  
  When the last successful job happened

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlDeploymentBatchPredictionSchedule(
  'string',
  'string',
)

qlik ml deployment batch-prediction schedule get \
  --deploymentId 'string' \
  --batch-predictionId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "batch-prediction-schedule",
    "attributes": {
      "status": "pending",
      "timezone": "America/Toronto",
      "recurrence": [
        [
          "Daily at 11:10:00 AM [\"RRULE:FREQ=DAILY;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]",
          "Weekly on Mondays at 11:10:00 AM [\"RRULE:FREQ=WEEKLY;INTERVAL:1;BYDAY=MO;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]"
        ]
      ],
      "endDateTime": "string",
      "chronosJobId": "string",
      "startDateTime": "string",
      "failureAttempts": 42,
      "applyDatasetChangeOnly": true,
      "lastSuccessfulDateTime": "string"
    }
  }
}

Updates the schedule for a batch prediction.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
batchPredictionId string

Required

ID of the batch prediction

Request Body

application/json array of objects
Values that can be patched.
- startDateTime: When the batch starts, if scheduled
- endDateTime: When batch ends, if scheduled
- timezone: Timezone used for scheduling
- recurrence: Array of strings to indicate when this batch recurs
- applyDatasetChangeOnly: Only run prediction if dataset has changed?
Show application/json properties
- op string
  
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- path string
  
  Required
  
  Path for the property you want to update
  
  Can be one of: "/startDateTime""/endDateTime""/timezone""/recurrence""/applyDatasetChangeOnly"
- value any
  
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

PATCH /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.updateMlDeploymentBatchPredictionSchedule(
  'string',
  'string',
  [
    {
      op: 'replace',
      path: '/startDateTime',
      value: '2022-09-14T12:00:00',
    },
  ],
)

qlik ml deployment batch-prediction schedule update \
  --deploymentId 'string' \
  --batch-predictionId 'string' \
  --op 'replace' \
  --path '/startDateTime' \
  --value 2022-09-14T12:00:00

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/startDateTime","value":"2022-09-14T12:00:00"}]'

Adds a schedule to a batch prediction.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
batchPredictionId string

Required

ID of the batch prediction

Request Body

application/json object

Input values for a batch prediction schedule
Show application/json properties
- data object
  
  Show data properties
  
  type string
  
  Can be one of: "batch-prediction-schedule"
  default = "batch-prediction-schedule"
  
  attributes object
  
  Configuration to schedule a batch prediction
  
  Show attributes properties
  
  timezone string
  
  Required
  
  Timezone used for the date-time fields
  
  recurrence array of strings
  
  Required
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTime string
  
  When the job is scheduled to finish, date needs to be now or in future
  
  startDateTime string
  
  Required
  
  When the job is scheduled to start, date needs to be now or in future
  
  applyDatasetChangeOnly boolean
  
  Required
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true

Responses

201

Created

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "batch-prediction-schedule"
  
  attributes object
  
  Required
  
  Batch prediction job schedule
  
  Show attributes properties
  
  status string
  
  The status of the schedule
  
  Can be one of: "pending""active""error""error_scheduler_unreachable""error_scheduler_callback_error""licence_advanced_features_required""failing_schedule_permission"
  
  timezone string
  
  Timezone used for the date-time fields
  
  recurrence array of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTime string
  
  When the job finished
  
  chronosJobId string
  
  The ID of the chronos job
  
  startDateTime string
  
  When the job is scheduled to start
  
  failureAttempts number
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnly boolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  lastSuccessfulDateTime string
  
  When the last successful job happened

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

PUT /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.setMlDeploymentBatchPredictionSchedule(
  'string',
  'string',
  {
    data: {
      attributes: {
        applyDatasetChangeOnly: true,
        endDateTime: '2035-12-31T23:59:00',
        recurrence: [
          'RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=16;BYMINUTE=30;BYSECOND=0',
        ],
        startDateTime: '2035-12-25T00:00:00',
        timezone: 'America/Toronto',
      },
      type: 'batch-prediction-schedule',
    },
  },
)

qlik ml deployment batch-prediction schedule set \
  --deploymentId 'string' \
  --batch-predictionId 'string' \
  --data-attributes-startDateTime '2035-12-25T00:00:00' \
  --data-attributes-timezone 'America/Toronto'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"batch-prediction-schedule","attributes":{"timezone":"America/Toronto","recurrence":["RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=16;BYMINUTE=30;BYSECOND=0"],"endDateTime":"2035-12-31T23:59:00","startDateTime":"2035-12-25T00:00:00","applyDatasetChangeOnly":true}}}'

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "batch-prediction-schedule",
    "attributes": {
      "status": "pending",
      "timezone": "America/Toronto",
      "recurrence": [
        [
          "Daily at 11:10:00 AM [\"RRULE:FREQ=DAILY;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]",
          "Weekly on Mondays at 11:10:00 AM [\"RRULE:FREQ=WEEKLY;INTERVAL:1;BYDAY=MO;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]"
        ]
      ],
      "endDateTime": "string",
      "chronosJobId": "string",
      "startDateTime": "string",
      "failureAttempts": 42,
      "applyDatasetChangeOnly": true,
      "lastSuccessfulDateTime": "string"
    }
  }
}

Deletes the schedule from a batch prediction.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment
batchPredictionId string

Required

ID of the batch prediction

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

DELETE /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.deleteMlDeploymentBatchPredictionSchedule(
  'string',
  'string',
)

qlik ml deployment batch-prediction schedule rm \
  --deploymentId 'string' \
  --batch-predictionId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Request Body

application/json object

Input values for adding deployed models to a deployment
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  type string
  
  Required
  
  Can be one of: "deployed-models"
  default = "deployed-models"
  
  attributes object
  
  Required
  
  Show attributes properties
  
  deployedModelIds array of strings
  
  Required
  
  IDs of all models deployed to the deployment

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/models/actions/add

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.addMlDeploymentModels('string', {
  data: {
    attributes: {
      deployedModelIds: [
        'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
      ],
    },
    type: 'deployed-models',
  },
})

qlik ml deployment model add 'string' \
  --data-attributes-deployedModelIds 'c35f4b70-3ce4-4a30-b62b-2aef16943bc4' \
  --data-type 'deployed-models'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/models/actions/add" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"deployed-models","attributes":{"deployedModelIds":["c35f4b70-3ce4-4a30-b62b-2aef16943bc4"]}}}'

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

deploymentId string

Required

ID of the deployment

Request Body

application/json object

Input values for adding deployed models to a deployment
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  type string
  
  Required
  
  Can be one of: "deployed-models"
  default = "deployed-models"
  
  attributes object
  
  Required
  
  Show attributes properties
  
  deployedModelIds array of strings
  
  Required
  
  IDs of all models deployed to the deployment

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/models/actions/remove

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.removeMlDeploymentModels('string', {
  data: {
    attributes: {
      deployedModelIds: [
        'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
      ],
    },
    type: 'deployed-models',
  },
})

qlik ml deployment model remove 'string' \
  --data-attributes-deployedModelIds 'c35f4b70-3ce4-4a30-b62b-2aef16943bc4' \
  --data-type 'deployed-models'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/models/actions/remove" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"deployed-models","attributes":{"deployedModelIds":["c35f4b70-3ce4-4a30-b62b-2aef16943bc4"]}}}'

Facts

Rate limit

Tier 2 (100 requests per minute)

Query Parameters

includeNotPredictedReason boolean

If true, reason why a prediction was not produced included response
includeShap boolean

If true, shapley values included in response
includeSource boolean

If true, source data included in response
index string

The name of the feature in the source data to use as an index in the response data. The column will be included with its original name and values. This is intended to allow the caller to join results with source data.

Path Parameters

deploymentId string

Required

ID of the deployment

Request Body

application/json object

Input values for creating realtime predictions
Show application/json properties
- rows array of arrays
  
  Rows of the dataset from which to produce predictions. Date features must be in ISO 8601 format.
- schema array of objects
  
  List of features in the dataset.
  
  Show schema properties
  
  name string
  
  The name of a feature in the dataset

Responses

200

Stream of combined prediction output returned successfully.

application/json object

Input values for creating realtime predictions
Show application/json properties
- data object
  
  Show data properties
  
  type string
  
  Can be one of: "realtime-prediction"
  default = "realtime-prediction"
  
  attributes object
  
  Show attributes properties
  
  rows array of arrays
  
  Rows of the dataset from which to produce predictions
  
  schema array of objects
  
  List of features in the dataset
  
  Show schema properties
  
  name string
  
  The name of a feature in the dataset

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

409

Conflict

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.runMlDeploymentRealtimePredictions(
  'string',
  {},
  {
    rows: [['string']],
    schema: [{ name: 'string' }],
  },
)

qlik ml deployment realtime-prediction 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"rows":[["string"]],"schema":[{"name":"string"}]}'

Example Response

{
  "data": {
    "type": "realtime-prediction",
    "attributes": {
      "rows": [
        [
          "string"
        ]
      ],
      "schema": [
        {
          "name": "string"
        }
      ]
    }
  }
}

Retrieves a list of experiments based on provided filter and sort parameters.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filter string
Experiment fields by which you can filter responses within this tenant
- ownerId ID string - ID of the owner/user that created the experiment
- spaceId ID string (or empty string for personal space) - ID of the space where the experiment is saved.
- experimentVersionId UUID string - ID of an experiment version in the experiment
- modelId UUID string - ID of a model associated with the experiment
- deploymentId UUID string - ID of a deployment of a model associated with the experiment
sort string

Field(s) by which to sort response

Can be one of: "createdAt""+createdAt""-createdAt""description""+description""-description""name""+name""-name""updatedAt""+updatedAt""-updatedAt"
limit integer

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offset integer

Number of rows to skip before getting page[size]

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "experiment"
  
  attributes object
  
  Required
  
  An AutoML experiment
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  tenantId string
  
  Required Filterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  description string
  
  Description of this entity
- meta object
  
  Meta for FIND operations
  
  Show meta properties
  
  count integer
  
  Required
- links object
  
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  last object
  
  Required
  
  Show last properties
  
  href string
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  Link to the next set of responses
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  Link to the previous set of responses
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Link to the current set of responses
  
  format = "uri"
  
  first object
  
  Required
  
  Show first properties
  
  href string
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/experiments

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlExperiments({})

qlik ml experiment ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "type": "experiment",
      "attributes": {
        "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "name": "string",
        "ownerId": "string",
        "spaceId": "string",
        "tenantId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "createdAt": "string",
        "updatedAt": "string",
        "description": "string"
      }
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  }
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

application/json object

Input for creating this entity
Show application/json properties
- data object
  
  Data container for ExperimentInput
  
  Show data properties
  
  type string
  
  Can be one of: "experiment"
  default = "experiment"
  
  attributes object
  
  Experiment input attributes
  
  Show attributes properties
  
  name string
  
  Required Filterable
  
  Name of this entity
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  description string
  
  Description of this entity

Responses

201

Created

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "experiment"
  
  attributes object
  
  Required
  
  An AutoML experiment
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  tenantId string
  
  Required Filterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  description string
  
  Description of this entity

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/experiments

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.createMlExperiment({
  data: {
    attributes: {
      description: 'string',
      name: 'string',
      spaceId: 'string',
    },
    type: 'experiment',
  },
})

qlik ml experiment create \
  --data-attributes-name 'string' \
  --data-attributes-spaceId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"experiment","attributes":{"name":"string","spaceId":"string","description":"string"}}}'

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "experiment",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "name": "string",
      "ownerId": "string",
      "spaceId": "string",
      "tenantId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "createdAt": "string",
      "updatedAt": "string",
      "description": "string"
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "experiment"
  
  attributes object
  
  Required
  
  An AutoML experiment
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  spaceId string
  
  Required Filterable
  
  Space ID for this entity (empty string for personal space)
  
  tenantId string
  
  Required Filterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  description string
  
  Description of this entity

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/experiments/{experimentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlExperiment('string')

qlik ml experiment get 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "experiment",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "name": "string",
      "ownerId": "string",
      "spaceId": "string",
      "tenantId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "createdAt": "string",
      "updatedAt": "string",
      "description": "string"
    }
  }
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment

Request Body

application/json array of objects

Experiment fields that can be patched. The following paths all require value to be a string: /name, /spaceId, and /description
Show application/json properties
- op string
  
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- path string
  
  Required
  
  Path for the property you want to update
  
  Can be one of: "/name""/description""/spaceId"
- value any
  
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

PATCH /api/v1/ml/experiments/{experimentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.patchMlExperiment('string', [
  {
    op: 'replace',
    path: '/name',
    value: 'New name',
  },

  {
    op: 'replace',
    path: '/description',
    value: 'New description',
  },

  {
    op: 'replace',
    path: '/spaceId',
    value: 'NEW_SPACE_ID',
  },
])

qlik ml experiment patch 'string' \
  --op 'replace' \
  --path '/name' \
  --value New name

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"New name"},{"op":"replace","path":"/description","value":"New description"},{"op":"replace","path":"/spaceId","value":"NEW_SPACE_ID"}]'

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

DELETE /api/v1/ml/experiments/{experimentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.deleteMlExperiment('string')

qlik ml experiment rm 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Returns model recommendations for a specified experiment, including the best-performing, fastest, and most accurate models based on evaluation metrics.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment

Request Body

application/json object

Criteria to determine which pool of models to provide recommendations from
Show application/json properties
- deployed boolean
  
  Whether to only consider models that are already deployed
- algorithms array of strings
  
  The model algorithms to consider
  
  Values may be any of: "catboost_classifier""catboost_regression""elasticnet_regression""gaussian_nb""kneighbors_classifier""lasso_regression""lasso""lgbm_classifier""lgbm_regression""linear_regression""logistic_regression""random_forest_classifier""random_forest_regression""sgd_regression""xgb_classifier""xgb_regression"
- fullSampling boolean
  
  Whether to only consider models with 100% sampling
- versionNumbers array of integers
  
  The versionNumbers of the experiment versions to consider models from

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  type string
  
  Required
  
  Can be one of: "model-recommendation"
  
  attributes object
  
  Required
  
  Model recommendations
  
  Show attributes properties
  
  bestModel object
  
  A model based on an algorithm within an experiment version.
  
  Show bestModel properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  hpoNum number
  
  Version number of the hyperparameter optimization
  
  seqNum number
  
  Model sequence number within the experiment version
  
  status string
  
  Model status. These are the status of the model in relation to experiments (i.e. training status).
  
  Can be one of: "pending""training_requested""training_done""ready""error"
  
  columns array of strings
  
  Dataset columns selected as features
  
  metrics object
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binary object
  
  Binary metrics for categorical values with two options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-binary-classification.htm
  
  Show binary properties
  
  f1 number
  
  The harmonic mean of precision and recall for training data
  
  auc number
  
  Area under curve (training data)
  
  mcc number
  
  Matthews correlation coefficient (training data)
  
  npv number
  
  Negative predictive value (training data)
  
  f1Test number
  
  The harmonic mean of precision and recall for test data
  
  recall number
  
  The true positive rate (training data)
  
  aucTest number
  
  Area under curve (test data)
  
  fallout number
  
  The false positive rate (training data)
  
  logLoss number
  
  Measures accuracy in logistic regression (training data)
  
  mccTest number
  
  Matthews correlation coefficient (test data)
  
  npvTest number
  
  Negative predictive value (test data)
  
  accuracy number
  
  Average measure of how often the model made correct predictions (training data)
  
  missRate number
  
  The false negative rate (training data)
  
  precision number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  threshold number
  
  Probability that a prediction is true (training data)
  
  recallTest number
  
  The true positive rate (test data)
  
  falloutTest number
  
  The false positive rate (test data)
  
  logLossTest number
  
  Measures accuracy in logistic regression (test data)
  
  specificity number
  
  The true negative rate (training data)
  
  accuracyTest number
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTest number
  
  The false negative rate (test data)
  
  trueNegative number
  
  Actual false values correctly predicted as false (training data)
  
  truePositive number
  
  Actual true values correctly predicted as true (training data)
  
  falseNegative number
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositive number
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTest number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTest number
  
  Probability that a prediction is true (test data)
  
  specificityTest number
  
  The true negative rate (test data)
  
  trueNegativeTest number
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTest number
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTest number
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTest number
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclass object
  
  Multiclass metrics for categorical values with 3+ options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-multiclass-classification.htm
  
  Show multiclass properties
  
  f1Macro number
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micro number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracy number
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weighted number
  
  Weighted F1 (training data)
  
  f1MacroTest number
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTest number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTest number
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTest number
  
  Weighted F1 (test data)
  
  confusionMatrix string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTest string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regression object
  
  Regression metrics for numeric values. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-regression.htm
  
  Show regression properties
  
  r2 number
  
  R squared (training data)
  
  mae number
  
  Mean absolute error (training data)
  
  mse number
  
  Mean squared error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  r2Test number
  
  R squared (test data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mseTest number
  
  Mean squared error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  timeseries object
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  mae number
  
  Mean absolute error (training data)
  
  mape number
  
  Mean absolute percentage error (training data)
  
  mase number
  
  Mean absolute scaled error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  mdape number
  
  Median absolute percentage error (training data)
  
  smape number
  
  Symmetric mean absolute percentage error (training data)
  
  wmape number
  
  Weighted mean absolute percentage error (training data)
  
  mnrmse number
  
  Mean root mean squared error (training data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mdnrmse number
  
  Median root mean squared error (training data)
  
  mapeTest number
  
  Mean absolute percentage error (test data)
  
  maseTest number
  
  Mean absolute scaled error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  mdapeTest number
  
  Median absolute percentage error (test data)
  
  smapeTest number
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTest number
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTest number
  
  Mean root mean squared error (test data)
  
  mdnrmseTest number
  
  Median root mean squared error (test data)
  
  predictionSpeed number
  
  Required
  
  This represents model prediction speed in rows/second
  
  batchNum number
  
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrv string
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithm string
  
  Filterable
  
  The algorithm used by this model
  
  createdAt string
  
  Timestamp when this was created
  
  updatedAt string
  
  Timestamp when this was updated
  
  modelState string
  
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  description string
  
  Description of this entity
  
  anomalyRatio number
  
  errorMessage string
  
  JSON string of error object
  
  samplingRatio number
  
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeatures array of strings
  
  droppedFeatures array of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  name string
  
  Name of dropped feature in the dataset
  
  reason string
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionId string
  
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeatures array of strings
  
  binaryImbalanceSampling object
  
  Show binaryImbalanceSampling properties
  
  sampleClass string
  
  sampleRatio number
  
  sampleDirection string
  
  Can be one of: "up""down"
  
  fastestModel object
  
  A model based on an algorithm within an experiment version.
  
  Show fastestModel properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  hpoNum number
  
  Version number of the hyperparameter optimization
  
  seqNum number
  
  Model sequence number within the experiment version
  
  status string
  
  Model status. These are the status of the model in relation to experiments (i.e. training status).
  
  Can be one of: "pending""training_requested""training_done""ready""error"
  
  columns array of strings
  
  Dataset columns selected as features
  
  metrics object
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binary object
  
  Binary metrics for categorical values with two options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-binary-classification.htm
  
  Show binary properties
  
  f1 number
  
  The harmonic mean of precision and recall for training data
  
  auc number
  
  Area under curve (training data)
  
  mcc number
  
  Matthews correlation coefficient (training data)
  
  npv number
  
  Negative predictive value (training data)
  
  f1Test number
  
  The harmonic mean of precision and recall for test data
  
  recall number
  
  The true positive rate (training data)
  
  aucTest number
  
  Area under curve (test data)
  
  fallout number
  
  The false positive rate (training data)
  
  logLoss number
  
  Measures accuracy in logistic regression (training data)
  
  mccTest number
  
  Matthews correlation coefficient (test data)
  
  npvTest number
  
  Negative predictive value (test data)
  
  accuracy number
  
  Average measure of how often the model made correct predictions (training data)
  
  missRate number
  
  The false negative rate (training data)
  
  precision number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  threshold number
  
  Probability that a prediction is true (training data)
  
  recallTest number
  
  The true positive rate (test data)
  
  falloutTest number
  
  The false positive rate (test data)
  
  logLossTest number
  
  Measures accuracy in logistic regression (test data)
  
  specificity number
  
  The true negative rate (training data)
  
  accuracyTest number
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTest number
  
  The false negative rate (test data)
  
  trueNegative number
  
  Actual false values correctly predicted as false (training data)
  
  truePositive number
  
  Actual true values correctly predicted as true (training data)
  
  falseNegative number
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositive number
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTest number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTest number
  
  Probability that a prediction is true (test data)
  
  specificityTest number
  
  The true negative rate (test data)
  
  trueNegativeTest number
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTest number
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTest number
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTest number
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclass object
  
  Multiclass metrics for categorical values with 3+ options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-multiclass-classification.htm
  
  Show multiclass properties
  
  f1Macro number
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micro number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracy number
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weighted number
  
  Weighted F1 (training data)
  
  f1MacroTest number
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTest number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTest number
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTest number
  
  Weighted F1 (test data)
  
  confusionMatrix string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTest string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regression object
  
  Regression metrics for numeric values. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-regression.htm
  
  Show regression properties
  
  r2 number
  
  R squared (training data)
  
  mae number
  
  Mean absolute error (training data)
  
  mse number
  
  Mean squared error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  r2Test number
  
  R squared (test data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mseTest number
  
  Mean squared error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  timeseries object
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  mae number
  
  Mean absolute error (training data)
  
  mape number
  
  Mean absolute percentage error (training data)
  
  mase number
  
  Mean absolute scaled error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  mdape number
  
  Median absolute percentage error (training data)
  
  smape number
  
  Symmetric mean absolute percentage error (training data)
  
  wmape number
  
  Weighted mean absolute percentage error (training data)
  
  mnrmse number
  
  Mean root mean squared error (training data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mdnrmse number
  
  Median root mean squared error (training data)
  
  mapeTest number
  
  Mean absolute percentage error (test data)
  
  maseTest number
  
  Mean absolute scaled error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  mdapeTest number
  
  Median absolute percentage error (test data)
  
  smapeTest number
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTest number
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTest number
  
  Mean root mean squared error (test data)
  
  mdnrmseTest number
  
  Median root mean squared error (test data)
  
  predictionSpeed number
  
  Required
  
  This represents model prediction speed in rows/second
  
  batchNum number
  
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrv string
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithm string
  
  Filterable
  
  The algorithm used by this model
  
  createdAt string
  
  Timestamp when this was created
  
  updatedAt string
  
  Timestamp when this was updated
  
  modelState string
  
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  description string
  
  Description of this entity
  
  anomalyRatio number
  
  errorMessage string
  
  JSON string of error object
  
  samplingRatio number
  
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeatures array of strings
  
  droppedFeatures array of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  name string
  
  Name of dropped feature in the dataset
  
  reason string
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionId string
  
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeatures array of strings
  
  binaryImbalanceSampling object
  
  Show binaryImbalanceSampling properties
  
  sampleClass string
  
  sampleRatio number
  
  sampleDirection string
  
  Can be one of: "up""down"
  
  mostAccurateModel object
  
  A model based on an algorithm within an experiment version.
  
  Show mostAccurateModel properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  hpoNum number
  
  Version number of the hyperparameter optimization
  
  seqNum number
  
  Model sequence number within the experiment version
  
  status string
  
  Model status. These are the status of the model in relation to experiments (i.e. training status).
  
  Can be one of: "pending""training_requested""training_done""ready""error"
  
  columns array of strings
  
  Dataset columns selected as features
  
  metrics object
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binary object
  
  Binary metrics for categorical values with two options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-binary-classification.htm
  
  Show binary properties
  
  f1 number
  
  The harmonic mean of precision and recall for training data
  
  auc number
  
  Area under curve (training data)
  
  mcc number
  
  Matthews correlation coefficient (training data)
  
  npv number
  
  Negative predictive value (training data)
  
  f1Test number
  
  The harmonic mean of precision and recall for test data
  
  recall number
  
  The true positive rate (training data)
  
  aucTest number
  
  Area under curve (test data)
  
  fallout number
  
  The false positive rate (training data)
  
  logLoss number
  
  Measures accuracy in logistic regression (training data)
  
  mccTest number
  
  Matthews correlation coefficient (test data)
  
  npvTest number
  
  Negative predictive value (test data)
  
  accuracy number
  
  Average measure of how often the model made correct predictions (training data)
  
  missRate number
  
  The false negative rate (training data)
  
  precision number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  threshold number
  
  Probability that a prediction is true (training data)
  
  recallTest number
  
  The true positive rate (test data)
  
  falloutTest number
  
  The false positive rate (test data)
  
  logLossTest number
  
  Measures accuracy in logistic regression (test data)
  
  specificity number
  
  The true negative rate (training data)
  
  accuracyTest number
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTest number
  
  The false negative rate (test data)
  
  trueNegative number
  
  Actual false values correctly predicted as false (training data)
  
  truePositive number
  
  Actual true values correctly predicted as true (training data)
  
  falseNegative number
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositive number
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTest number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTest number
  
  Probability that a prediction is true (test data)
  
  specificityTest number
  
  The true negative rate (test data)
  
  trueNegativeTest number
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTest number
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTest number
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTest number
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclass object
  
  Multiclass metrics for categorical values with 3+ options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-multiclass-classification.htm
  
  Show multiclass properties
  
  f1Macro number
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micro number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracy number
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weighted number
  
  Weighted F1 (training data)
  
  f1MacroTest number
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTest number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTest number
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTest number
  
  Weighted F1 (test data)
  
  confusionMatrix string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTest string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regression object
  
  Regression metrics for numeric values. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-regression.htm
  
  Show regression properties
  
  r2 number
  
  R squared (training data)
  
  mae number
  
  Mean absolute error (training data)
  
  mse number
  
  Mean squared error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  r2Test number
  
  R squared (test data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mseTest number
  
  Mean squared error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  timeseries object
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  mae number
  
  Mean absolute error (training data)
  
  mape number
  
  Mean absolute percentage error (training data)
  
  mase number
  
  Mean absolute scaled error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  mdape number
  
  Median absolute percentage error (training data)
  
  smape number
  
  Symmetric mean absolute percentage error (training data)
  
  wmape number
  
  Weighted mean absolute percentage error (training data)
  
  mnrmse number
  
  Mean root mean squared error (training data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mdnrmse number
  
  Median root mean squared error (training data)
  
  mapeTest number
  
  Mean absolute percentage error (test data)
  
  maseTest number
  
  Mean absolute scaled error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  mdapeTest number
  
  Median absolute percentage error (test data)
  
  smapeTest number
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTest number
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTest number
  
  Mean root mean squared error (test data)
  
  mdnrmseTest number
  
  Median root mean squared error (test data)
  
  predictionSpeed number
  
  Required
  
  This represents model prediction speed in rows/second
  
  batchNum number
  
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrv string
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithm string
  
  Filterable
  
  The algorithm used by this model
  
  createdAt string
  
  Timestamp when this was created
  
  updatedAt string
  
  Timestamp when this was updated
  
  modelState string
  
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  description string
  
  Description of this entity
  
  anomalyRatio number
  
  errorMessage string
  
  JSON string of error object
  
  samplingRatio number
  
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeatures array of strings
  
  droppedFeatures array of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  name string
  
  Name of dropped feature in the dataset
  
  reason string
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionId string
  
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeatures array of strings
  
  binaryImbalanceSampling object
  
  Show binaryImbalanceSampling properties
  
  sampleClass string
  
  sampleRatio number
  
  sampleDirection string
  
  Can be one of: "up""down"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/experiments/{experimentId}/actions/recommend-models

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.recommendModelsMlExperiment(
  'string',
  {
    algorithms: ['catboost_classifier'],
    deployed: true,
    fullSampling: true,
    versionNumbers: [1],
  },
)

qlik ml experiment recommend-models 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}/actions/recommend-models" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"deployed":true,"algorithms":["catboost_classifier"],"fullSampling":true,"versionNumbers":[1]}'

Example Response

{
  "data": {
    "type": "model-recommendation",
    "attributes": {
      "bestModel": {
        "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",
        "hpoNum": 42,
        "seqNum": 42,
        "status": "pending",
        "columns": [
          "string"
        ],
        "metrics": {
          "predictionSpeed": 42
        },
        "batchNum": 42,
        "algoAbbrv": "CATBC",
        "algorithm": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "modelState": "pending",
        "description": "string",
        "anomalyRatio": 42,
        "errorMessage": "string",
        "samplingRatio": 42,
        "binningFeatures": [
          "string"
        ],
        "droppedFeatures": [
          {
            "name": "string",
            "reason": "highly_correlated"
          }
        ],
        "experimentVersionId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "powerTransformFeatures": [
          "string"
        ],
        "binaryImbalanceSampling": {
          "sampleClass": "string",
          "sampleRatio": 42,
          "sampleDirection": "up"
        }
      },
      "fastestModel": {
        "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",
        "hpoNum": 42,
        "seqNum": 42,
        "status": "pending",
        "columns": [
          "string"
        ],
        "metrics": {
          "predictionSpeed": 42
        },
        "batchNum": 42,
        "algoAbbrv": "CATBC",
        "algorithm": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "modelState": "pending",
        "description": "string",
        "anomalyRatio": 42,
        "errorMessage": "string",
        "samplingRatio": 42,
        "binningFeatures": [
          "string"
        ],
        "droppedFeatures": [
          {
            "name": "string",
            "reason": "highly_correlated"
          }
        ],
        "experimentVersionId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "powerTransformFeatures": [
          "string"
        ],
        "binaryImbalanceSampling": {
          "sampleClass": "string",
          "sampleRatio": 42,
          "sampleDirection": "up"
        }
      },
      "mostAccurateModel": {
        "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",
        "hpoNum": 42,
        "seqNum": 42,
        "status": "pending",
        "columns": [
          "string"
        ],
        "metrics": {
          "predictionSpeed": 42
        },
        "batchNum": 42,
        "algoAbbrv": "CATBC",
        "algorithm": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "modelState": "pending",
        "description": "string",
        "anomalyRatio": 42,
        "errorMessage": "string",
        "samplingRatio": 42,
        "binningFeatures": [
          "string"
        ],
        "droppedFeatures": [
          {
            "name": "string",
            "reason": "highly_correlated"
          }
        ],
        "experimentVersionId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "powerTransformFeatures": [
          "string"
        ],
        "binaryImbalanceSampling": {
          "sampleClass": "string",
          "sampleRatio": 42,
          "sampleDirection": "up"
        }
      }
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filter string
Model fields you can filter by:
- experimentVersionId UUID string - Find by experiment version ID
- batchNum UUID string - Search by batch number
- isHpo boolean - Is hyperparameter optimization used?
- isMetrics boolean - Are metrics for regression, binary, or multiclass are used?
- id UUID string - Find by model ID
- algorithm enum string - Find by algorithm
  - Valid algorithms: catboost_classifier, catboost_regression, elasticnet_regression, gaussian_nb, kneighbors_classifier, lasso_regression, lasso, lgbm_classifier, lgbm_regression, linear_regression, logistic_regression, random_forest_classifier, random_forest_regression, sgd_regression, xgb_classifier, xgb_regression
- status enum string - find by status
  - Valid statuses: pending, training_requested, training_done, ready, error
- hasDeployment boolean - Models that are part of a deployment
- nameContains string - Models with name includes this case-insensitive string
- exactName string - Models with exact name. Model names may not be unique
- samplingRatio number - Find models by sampling ratio
- modelState enum string - State by which to find models
  - Valid states: pending, enabled, disabled, inactive
sort string

Field(s) by which to sort response

Can be one of: "createdAt""+createdAt""-createdAt""description""+description""-description""name""+name""-name""updatedAt""+updatedAt""-updatedAt"
limit integer

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offset integer

Number of rows to skip before getting page[size]

Path Parameters

experimentId string

Required

ID of the experiment

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "model"
  
  attributes object
  
  Required
  
  A model based on an algorithm within an experiment version.
  
  Show attributes properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  hpoNum number
  
  Version number of the hyperparameter optimization
  
  seqNum number
  
  Model sequence number within the experiment version
  
  status string
  
  Model status. These are the status of the model in relation to experiments (i.e. training status).
  
  Can be one of: "pending""training_requested""training_done""ready""error"
  
  columns array of strings
  
  Dataset columns selected as features
  
  metrics object
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binary object
  
  Binary metrics for categorical values with two options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-binary-classification.htm
  
  Show binary properties
  
  f1 number
  
  The harmonic mean of precision and recall for training data
  
  auc number
  
  Area under curve (training data)
  
  mcc number
  
  Matthews correlation coefficient (training data)
  
  npv number
  
  Negative predictive value (training data)
  
  f1Test number
  
  The harmonic mean of precision and recall for test data
  
  recall number
  
  The true positive rate (training data)
  
  aucTest number
  
  Area under curve (test data)
  
  fallout number
  
  The false positive rate (training data)
  
  logLoss number
  
  Measures accuracy in logistic regression (training data)
  
  mccTest number
  
  Matthews correlation coefficient (test data)
  
  npvTest number
  
  Negative predictive value (test data)
  
  accuracy number
  
  Average measure of how often the model made correct predictions (training data)
  
  missRate number
  
  The false negative rate (training data)
  
  precision number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  threshold number
  
  Probability that a prediction is true (training data)
  
  recallTest number
  
  The true positive rate (test data)
  
  falloutTest number
  
  The false positive rate (test data)
  
  logLossTest number
  
  Measures accuracy in logistic regression (test data)
  
  specificity number
  
  The true negative rate (training data)
  
  accuracyTest number
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTest number
  
  The false negative rate (test data)
  
  trueNegative number
  
  Actual false values correctly predicted as false (training data)
  
  truePositive number
  
  Actual true values correctly predicted as true (training data)
  
  falseNegative number
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositive number
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTest number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTest number
  
  Probability that a prediction is true (test data)
  
  specificityTest number
  
  The true negative rate (test data)
  
  trueNegativeTest number
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTest number
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTest number
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTest number
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclass object
  
  Multiclass metrics for categorical values with 3+ options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-multiclass-classification.htm
  
  Show multiclass properties
  
  f1Macro number
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micro number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracy number
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weighted number
  
  Weighted F1 (training data)
  
  f1MacroTest number
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTest number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTest number
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTest number
  
  Weighted F1 (test data)
  
  confusionMatrix string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTest string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regression object
  
  Regression metrics for numeric values. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-regression.htm
  
  Show regression properties
  
  r2 number
  
  R squared (training data)
  
  mae number
  
  Mean absolute error (training data)
  
  mse number
  
  Mean squared error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  r2Test number
  
  R squared (test data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mseTest number
  
  Mean squared error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  timeseries object
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  mae number
  
  Mean absolute error (training data)
  
  mape number
  
  Mean absolute percentage error (training data)
  
  mase number
  
  Mean absolute scaled error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  mdape number
  
  Median absolute percentage error (training data)
  
  smape number
  
  Symmetric mean absolute percentage error (training data)
  
  wmape number
  
  Weighted mean absolute percentage error (training data)
  
  mnrmse number
  
  Mean root mean squared error (training data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mdnrmse number
  
  Median root mean squared error (training data)
  
  mapeTest number
  
  Mean absolute percentage error (test data)
  
  maseTest number
  
  Mean absolute scaled error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  mdapeTest number
  
  Median absolute percentage error (test data)
  
  smapeTest number
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTest number
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTest number
  
  Mean root mean squared error (test data)
  
  mdnrmseTest number
  
  Median root mean squared error (test data)
  
  predictionSpeed number
  
  Model prediction speed in rows/second (from recommend-models endpoint)
  
  batchNum number
  
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrv string
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithm string
  
  Filterable
  
  The algorithm used by this model
  
  createdAt string
  
  Timestamp when this was created
  
  updatedAt string
  
  Timestamp when this was updated
  
  modelState string
  
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  description string
  
  Description of this entity
  
  anomalyRatio number
  
  errorMessage string
  
  JSON string of error object
  
  samplingRatio number
  
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeatures array of strings
  
  droppedFeatures array of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  name string
  
  Name of dropped feature in the dataset
  
  reason string
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionId string
  
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeatures array of strings
  
  binaryImbalanceSampling object
  
  Show binaryImbalanceSampling properties
  
  sampleClass string
  
  sampleRatio number
  
  sampleDirection string
  
  Can be one of: "up""down"
- meta object
  
  Meta for FIND operations
  
  Show meta properties
  
  count integer
  
  Required
- links object
  
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  last object
  
  Required
  
  Show last properties
  
  href string
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  Link to the next set of responses
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  Link to the previous set of responses
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Link to the current set of responses
  
  format = "uri"
  
  first object
  
  Required
  
  Show first properties
  
  href string
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/experiments/{experimentId}/models

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlExperimentModels('string', {})

qlik ml experiment model ls \
  --experimentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}/models" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "type": "model",
      "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",
        "hpoNum": 42,
        "seqNum": 42,
        "status": "pending",
        "columns": [
          "string"
        ],
        "metrics": {
          "binary": {
            "f1": 42,
            "auc": 42,
            "mcc": 42,
            "npv": 42,
            "f1Test": 42,
            "recall": 42,
            "aucTest": 42,
            "fallout": 42,
            "logLoss": 42,
            "mccTest": 42,
            "npvTest": 42,
            "accuracy": 42,
            "missRate": 42,
            "precision": 42,
            "threshold": 42,
            "recallTest": 42,
            "falloutTest": 42,
            "logLossTest": 42,
            "specificity": 42,
            "accuracyTest": 42,
            "missRateTest": 42,
            "trueNegative": 42,
            "truePositive": 42,
            "falseNegative": 42,
            "falsePositive": 42,
            "precisionTest": 42,
            "thresholdTest": 42,
            "specificityTest": 42,
            "trueNegativeTest": 42,
            "truePositiveTest": 42,
            "falseNegativeTest": 42,
            "falsePositiveTest": 42
          },
          "multiclass": {
            "f1Macro": 42,
            "f1Micro": 42,
            "accuracy": 42,
            "f1Weighted": 42,
            "f1MacroTest": 42,
            "f1MicroTest": 42,
            "accuracyTest": 42,
            "f1WeightedTest": 42,
            "confusionMatrix": "string",
            "confusionMatrixTest": "string"
          },
          "regression": {
            "r2": 42,
            "mae": 42,
            "mse": 42,
            "rmse": 42,
            "r2Test": 42,
            "maeTest": 42,
            "mseTest": 42,
            "rmseTest": 42
          },
          "timeseries": {
            "mae": 42,
            "mape": 42,
            "mase": 42,
            "rmse": 42,
            "mdape": 42,
            "smape": 42,
            "wmape": 42,
            "mnrmse": 42,
            "maeTest": 42,
            "mdnrmse": 42,
            "mapeTest": 42,
            "maseTest": 42,
            "rmseTest": 42,
            "mdapeTest": 42,
            "smapeTest": 42,
            "wmapeTest": 42,
            "mnrmseTest": 42,
            "mdnrmseTest": 42
          },
          "predictionSpeed": 42
        },
        "batchNum": 42,
        "algoAbbrv": "CATBC",
        "algorithm": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "modelState": "pending",
        "description": "string",
        "anomalyRatio": 42,
        "errorMessage": "string",
        "samplingRatio": 42,
        "binningFeatures": [
          "string"
        ],
        "droppedFeatures": [
          {
            "name": "string",
            "reason": "highly_correlated"
          }
        ],
        "experimentVersionId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "powerTransformFeatures": [
          "string"
        ],
        "binaryImbalanceSampling": {
          "sampleClass": "string",
          "sampleRatio": 42,
          "sampleDirection": "up"
        }
      }
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment
modelId string

Required

ID of the model

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "model"
  
  attributes object
  
  Required
  
  A model based on an algorithm within an experiment version.
  
  Show attributes properties
  
  id string
  
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  hpoNum number
  
  Version number of the hyperparameter optimization
  
  seqNum number
  
  Model sequence number within the experiment version
  
  status string
  
  Model status. These are the status of the model in relation to experiments (i.e. training status).
  
  Can be one of: "pending""training_requested""training_done""ready""error"
  
  columns array of strings
  
  Dataset columns selected as features
  
  metrics object
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binary object
  
  Binary metrics for categorical values with two options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-binary-classification.htm
  
  Show binary properties
  
  f1 number
  
  The harmonic mean of precision and recall for training data
  
  auc number
  
  Area under curve (training data)
  
  mcc number
  
  Matthews correlation coefficient (training data)
  
  npv number
  
  Negative predictive value (training data)
  
  f1Test number
  
  The harmonic mean of precision and recall for test data
  
  recall number
  
  The true positive rate (training data)
  
  aucTest number
  
  Area under curve (test data)
  
  fallout number
  
  The false positive rate (training data)
  
  logLoss number
  
  Measures accuracy in logistic regression (training data)
  
  mccTest number
  
  Matthews correlation coefficient (test data)
  
  npvTest number
  
  Negative predictive value (test data)
  
  accuracy number
  
  Average measure of how often the model made correct predictions (training data)
  
  missRate number
  
  The false negative rate (training data)
  
  precision number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  threshold number
  
  Probability that a prediction is true (training data)
  
  recallTest number
  
  The true positive rate (test data)
  
  falloutTest number
  
  The false positive rate (test data)
  
  logLossTest number
  
  Measures accuracy in logistic regression (test data)
  
  specificity number
  
  The true negative rate (training data)
  
  accuracyTest number
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTest number
  
  The false negative rate (test data)
  
  trueNegative number
  
  Actual false values correctly predicted as false (training data)
  
  truePositive number
  
  Actual true values correctly predicted as true (training data)
  
  falseNegative number
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositive number
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTest number
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTest number
  
  Probability that a prediction is true (test data)
  
  specificityTest number
  
  The true negative rate (test data)
  
  trueNegativeTest number
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTest number
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTest number
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTest number
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclass object
  
  Multiclass metrics for categorical values with 3+ options. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-multiclass-classification.htm
  
  Show multiclass properties
  
  f1Macro number
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micro number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracy number
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weighted number
  
  Weighted F1 (training data)
  
  f1MacroTest number
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTest number
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTest number
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTest number
  
  Weighted F1 (test data)
  
  confusionMatrix string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTest string
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regression object
  
  Regression metrics for numeric values. Details: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-regression.htm
  
  Show regression properties
  
  r2 number
  
  R squared (training data)
  
  mae number
  
  Mean absolute error (training data)
  
  mse number
  
  Mean squared error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  r2Test number
  
  R squared (test data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mseTest number
  
  Mean squared error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  timeseries object
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  mae number
  
  Mean absolute error (training data)
  
  mape number
  
  Mean absolute percentage error (training data)
  
  mase number
  
  Mean absolute scaled error (training data)
  
  rmse number
  
  Root mean squared error (training data)
  
  mdape number
  
  Median absolute percentage error (training data)
  
  smape number
  
  Symmetric mean absolute percentage error (training data)
  
  wmape number
  
  Weighted mean absolute percentage error (training data)
  
  mnrmse number
  
  Mean root mean squared error (training data)
  
  maeTest number
  
  Mean absolute error (test data)
  
  mdnrmse number
  
  Median root mean squared error (training data)
  
  mapeTest number
  
  Mean absolute percentage error (test data)
  
  maseTest number
  
  Mean absolute scaled error (test data)
  
  rmseTest number
  
  Root mean squared error (test data)
  
  mdapeTest number
  
  Median absolute percentage error (test data)
  
  smapeTest number
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTest number
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTest number
  
  Mean root mean squared error (test data)
  
  mdnrmseTest number
  
  Median root mean squared error (test data)
  
  predictionSpeed number
  
  Model prediction speed in rows/second (from recommend-models endpoint)
  
  batchNum number
  
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrv string
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithm string
  
  Filterable
  
  The algorithm used by this model
  
  createdAt string
  
  Timestamp when this was created
  
  updatedAt string
  
  Timestamp when this was updated
  
  modelState string
  
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  description string
  
  Description of this entity
  
  anomalyRatio number
  
  errorMessage string
  
  JSON string of error object
  
  samplingRatio number
  
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeatures array of strings
  
  droppedFeatures array of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  name string
  
  Name of dropped feature in the dataset
  
  reason string
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionId string
  
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeatures array of strings
  
  binaryImbalanceSampling object
  
  Show binaryImbalanceSampling properties
  
  sampleClass string
  
  sampleRatio number
  
  sampleDirection string
  
  Can be one of: "up""down"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/experiments/{experimentId}/models/{modelId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlExperimentModel(
  'string',
  'string',
)

qlik ml experiment model get 'string' \
  --experimentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}/models/{modelId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "model",
    "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",
      "hpoNum": 42,
      "seqNum": 42,
      "status": "pending",
      "columns": [
        "string"
      ],
      "metrics": {
        "binary": {
          "f1": 42,
          "auc": 42,
          "mcc": 42,
          "npv": 42,
          "f1Test": 42,
          "recall": 42,
          "aucTest": 42,
          "fallout": 42,
          "logLoss": 42,
          "mccTest": 42,
          "npvTest": 42,
          "accuracy": 42,
          "missRate": 42,
          "precision": 42,
          "threshold": 42,
          "recallTest": 42,
          "falloutTest": 42,
          "logLossTest": 42,
          "specificity": 42,
          "accuracyTest": 42,
          "missRateTest": 42,
          "trueNegative": 42,
          "truePositive": 42,
          "falseNegative": 42,
          "falsePositive": 42,
          "precisionTest": 42,
          "thresholdTest": 42,
          "specificityTest": 42,
          "trueNegativeTest": 42,
          "truePositiveTest": 42,
          "falseNegativeTest": 42,
          "falsePositiveTest": 42
        },
        "multiclass": {
          "f1Macro": 42,
          "f1Micro": 42,
          "accuracy": 42,
          "f1Weighted": 42,
          "f1MacroTest": 42,
          "f1MicroTest": 42,
          "accuracyTest": 42,
          "f1WeightedTest": 42,
          "confusionMatrix": "string",
          "confusionMatrixTest": "string"
        },
        "regression": {
          "r2": 42,
          "mae": 42,
          "mse": 42,
          "rmse": 42,
          "r2Test": 42,
          "maeTest": 42,
          "mseTest": 42,
          "rmseTest": 42
        },
        "timeseries": {
          "mae": 42,
          "mape": 42,
          "mase": 42,
          "rmse": 42,
          "mdape": 42,
          "smape": 42,
          "wmape": 42,
          "mnrmse": 42,
          "maeTest": 42,
          "mdnrmse": 42,
          "mapeTest": 42,
          "maseTest": 42,
          "rmseTest": 42,
          "mdapeTest": 42,
          "smapeTest": 42,
          "wmapeTest": 42,
          "mnrmseTest": 42,
          "mdnrmseTest": 42
        },
        "predictionSpeed": 42
      },
      "batchNum": 42,
      "algoAbbrv": "CATBC",
      "algorithm": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "modelState": "pending",
      "description": "string",
      "anomalyRatio": 42,
      "errorMessage": "string",
      "samplingRatio": 42,
      "binningFeatures": [
        "string"
      ],
      "droppedFeatures": [
        {
          "name": "string",
          "reason": "highly_correlated"
        }
      ],
      "experimentVersionId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "powerTransformFeatures": [
        "string"
      ],
      "binaryImbalanceSampling": {
        "sampleClass": "string",
        "sampleRatio": 42,
        "sampleDirection": "up"
      }
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filter string
Experiment version filter options
- isRunning boolean - Is the experiment version running (training models)?
- isSettled boolean - Is the experiment version settled?
- status enum string - Status to filter by. Omit to get models of any status.
  - Valid statuses: pending, ready, error, cancelled
- modelId UUID string - ID of a model associated with the experiment
sort string

Field(s) by which to sort response

Can be one of: "createdAt""+createdAt""-createdAt""description""+description""-description""experimentMode""+experimentMode""-experimentMode""experimentType""+experimentType""-experimentType""name""+name""-name""status""+status""-status""updatedAt""+updatedAt""-updatedAt""versionNumber""+versionNumber""-versionNumber"
limit integer

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offset integer

Number of rows to skip before getting page[size]

Path Parameters

experimentId string

Required

ID of the experiment

Responses

200

OK

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "experiment-version"
  
  attributes object
  
  Required
  
  An AutoML experiment version. This is a configuration for training models within an experiment.
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  status string
  
  Required Filterable
  
  Current status of this entity
  
  Can be one of: "ready""error""cancelled""pending""dataprep_requested""datasync_requested""datasync_done"
  default = "pending"
  
  target string
  
  Required
  
  The target field in the dataset
  
  pipeline object
  
  Pipeline metadata including transformations to apply to columns and specific schema configuration data
  
  Show pipeline properties
  
  transforms array of objects
  
  Show transforms properties
  
  column object
  
  Show column properties
  
  name string
  
  Required
  
  changeType string
  
  Required
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  profileId string
  
  ID of the dataset profile with metadata about source data
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  algorithms array of strings
  
  List of algorithms selected for model training in this version
  
  Values may be any of: "catboost_classifier""catboost_regression""elasticnet_regression""gaussian_nb""kneighbors_classifier""lasso_regression""lasso""lgbm_classifier""lgbm_regression""linear_regression""logistic_regression""random_forest_classifier""random_forest_regression""sgd_regression""xgb_classifier""xgb_regression"
  
  topModelId string
  
  ID of the top model (based on training scores) in this experiment version
  
  dateIndexes array of strings
  
  A optional date column name to index
  
  minItems = 0, maxItems = 1
  
  errorMessage string
  
  JSON string of error object
  
  experimentId string
  
  Required
  
  ID of the experiment
  
  format = "uuid"
  
  featuresList array of objects
  
  List of features from your dataset for creating Experiment Versions. This appears in from ProfileInsights response (in the defaultVersionConfig). You can adjust the default settings before using it as input to create or update Experiment Versions.
  
  Show featuresList properties
  
  name string
  
  Name of the feature column
  
  include boolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataType string
  
  The data type of this feature in your dataset
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM""FLOAT""OBJECT"
  
  changeType string
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  parentFeature string
  
  The parent feature name for engineered features. e.g. OrderDate may be the parent of its engineered features (features extracted from parent) like OrderDate.YEAR, OrderDate.MONTH, etc.
  
  lastBatchNum integer
  
  Number of the last batch
  
  datasetOrigin string
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  default = "new"
  
  versionNumber integer
  
  -based sequential version number within the experiment
  
  experimentMode string
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  default = "intelligent"
  
  experimentType string
  
  Required
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"
  
  createdByUserId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  trainingDuration integer
  
  Maximum allowed training duration in seconds, not elapsed training time.
  
  minimum = 900, maximum = 21600
  
  maxTrainingDuration integer
  
  Maximum allowed training duration in seconds, not elapsed training time.
  
  minimum = 900, maximum = 21600
  
  preprocessedInsights array of objects
  
  Preprocessed insights. Like feature insights but with fewer details.
  
  Show preprocessedInsights properties
  
  name string
  
  Required
  
  Name of the preprocessed insight column
  
  insights array of strings
  
  Required
  
  Preliminary list of column/feature insights available after preprocessing but before feature insights are available
  
  Values may be any of: "is_free_text""cannot_be_processed_as_free_text""is_date_engineered""has_target_leakage""feature_type_change_invalid""feature_type_change_failed""feature_type_change_successful""data_bias_detected""representation_bias_detected"
  
  willBeDropped boolean
  
  Required
  
  Whether this feature insight will be dropped due to free text or high cardinality that makes it less useful
- meta object
  
  Meta for FIND operations
  
  Show meta properties
  
  count integer
  
  Required
- links object
  
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  last object
  
  Required
  
  Show last properties
  
  href string
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  Link to the next set of responses
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  Link to the previous set of responses
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Link to the current set of responses
  
  format = "uri"
  
  first object
  
  Required
  
  Show first properties
  
  href string
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/experiments/{experimentId}/versions

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlExperimentVersions(
  'string',
  {},
)

qlik ml experiment version ls \
  --experimentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}/versions" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "type": "experiment-version",
      "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",
        "status": "pending",
        "target": "TargetColumn",
        "pipeline": {
          "transforms": [
            {
              "column": {
                "name": "string",
                "changeType": "string"
              }
            }
          ]
        },
        "createdAt": "string",
        "dataSetId": "672e55cfcadfb8a18281523e",
        "profileId": "string",
        "updatedAt": "string",
        "algorithms": [
          "catboost_classifier"
        ],
        "topModelId": "string",
        "dateIndexes": [
          "string"
        ],
        "errorMessage": "string",
        "experimentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "featuresList": [
          {
            "name": "ColumnA",
            "include": true,
            "dataType": "STRING",
            "changeType": null,
            "featureType": "categorical",
            "parentFeature": null
          }
        ],
        "lastBatchNum": 42,
        "datasetOrigin": "new",
        "versionNumber": 42,
        "experimentMode": "intelligent",
        "experimentType": "binary",
        "createdByUserId": "string",
        "trainingDuration": 900,
        "maxTrainingDuration": 900,
        "preprocessedInsights": [
          {
            "name": "string",
            "insights": [],
            "willBeDropped": true
          }
        ]
      }
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  }
}

Creates an experiment version. Poll this version and check its status field to determine when models are finished training.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment

Request Body

application/json object

Input for creating a new experiment version. Defaults provided in the ProfileInsights response.
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  type string
  
  Required
  
  Can be one of: "experiment-version"
  default = "experiment-version"
  
  attributes object
  
  Required
  
  Show attributes properties
  
  name string
  
  Required
  
  default = "Experiment version name. Defaults to current date."
  
  target string
  
  Required
  
  The target field in the dataset. Set in first experiment version and can't be changed in subsequent versions.
  
  pipeline object
  
  Pipeline metadata including transformations to apply to columns and specific schema configuration data
  
  Show pipeline properties
  
  transforms array of objects
  
  Show transforms properties
  
  column object
  
  Show column properties
  
  name string
  
  Required
  
  changeType string
  
  Required
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  algorithms array of strings
  
  Algorithms used for model training in this version. See documentation for valid algorithms for each experimentType.
  
  If not provided, defaults to all valid algorithms for your experimentType.
  
  Values may be any of: "catboost_classifier""catboost_regression""elasticnet_regression""gaussian_nb""kneighbors_classifier""lasso_regression""lasso""lgbm_classifier""lgbm_regression""linear_regression""logistic_regression""random_forest_classifier""random_forest_regression""sgd_regression""xgb_classifier""xgb_regression"
  
  dateIndexes array of strings
  
  A optional date column name to index
  
  minItems = 0, maxItems = 1
  
  featuresList array of objects
  
  Required
  
  List of features from your dataset for creating Experiment Versions. This appears in from ProfileInsights response (in the defaultVersionConfig). You can adjust the default settings before using it as input to create or update Experiment Versions.
  
  Show featuresList properties
  
  name string
  
  Name of the feature column
  
  include boolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataType string
  
  The data type of this feature in your dataset
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM""FLOAT""OBJECT"
  
  changeType string
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  parentFeature string
  
  The parent feature name for engineered features. e.g. OrderDate may be the parent of its engineered features (features extracted from parent) like OrderDate.YEAR, OrderDate.MONTH, etc.
  
  datasetOrigin string
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  default = "new"
  
  experimentMode string
  
  Required
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  default = "intelligent"
  
  experimentType string
  
  Required
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"
  
  trainingDuration integer
  
  Maximum allowed training duration in seconds, not elapsed training time. maxTrainingDuration takes precedence over trainingDuration when both are provided. If neither field is provided, the maximum for the experiment type is used. Accepted ranges:
  
  min 900 (15m), max 21600 (6h)
  
  minimum = 900, maximum = 21600
  
  maxTrainingDuration integer
  
  Maximum allowed training duration in seconds, not elapsed training time. maxTrainingDuration takes precedence over trainingDuration when both are provided. If neither field is provided, the maximum for the experiment type is used. Accepted ranges:
  
  min 900 (15m), max 21600 (6h)
  
  minimum = 900, maximum = 21600

Responses

201

Accepted

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "experiment-version"
  
  attributes object
  
  Required
  
  An AutoML experiment version. This is a configuration for training models within an experiment.
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  status string
  
  Required Filterable
  
  Current status of this entity
  
  Can be one of: "ready""error""cancelled""pending""dataprep_requested""datasync_requested""datasync_done"
  default = "pending"
  
  target string
  
  Required
  
  The target field in the dataset
  
  pipeline object
  
  Pipeline metadata including transformations to apply to columns and specific schema configuration data
  
  Show pipeline properties
  
  transforms array of objects
  
  Show transforms properties
  
  column object
  
  Show column properties
  
  name string
  
  Required
  
  changeType string
  
  Required
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  profileId string
  
  ID of the dataset profile with metadata about source data
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  algorithms array of strings
  
  List of algorithms selected for model training in this version
  
  Values may be any of: "catboost_classifier""catboost_regression""elasticnet_regression""gaussian_nb""kneighbors_classifier""lasso_regression""lasso""lgbm_classifier""lgbm_regression""linear_regression""logistic_regression""random_forest_classifier""random_forest_regression""sgd_regression""xgb_classifier""xgb_regression"
  
  topModelId string
  
  ID of the top model (based on training scores) in this experiment version
  
  dateIndexes array of strings
  
  A optional date column name to index
  
  minItems = 0, maxItems = 1
  
  errorMessage string
  
  JSON string of error object
  
  experimentId string
  
  Required
  
  ID of the experiment
  
  format = "uuid"
  
  featuresList array of objects
  
  List of features from your dataset for creating Experiment Versions. This appears in from ProfileInsights response (in the defaultVersionConfig). You can adjust the default settings before using it as input to create or update Experiment Versions.
  
  Show featuresList properties
  
  name string
  
  Name of the feature column
  
  include boolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataType string
  
  The data type of this feature in your dataset
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM""FLOAT""OBJECT"
  
  changeType string
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  parentFeature string
  
  The parent feature name for engineered features. e.g. OrderDate may be the parent of its engineered features (features extracted from parent) like OrderDate.YEAR, OrderDate.MONTH, etc.
  
  lastBatchNum integer
  
  Number of the last batch
  
  datasetOrigin string
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  default = "new"
  
  versionNumber integer
  
  -based sequential version number within the experiment
  
  experimentMode string
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  default = "intelligent"
  
  experimentType string
  
  Required
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"
  
  createdByUserId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  trainingDuration integer
  
  Maximum allowed training duration in seconds, not elapsed training time.
  
  minimum = 900, maximum = 21600
  
  maxTrainingDuration integer
  
  Maximum allowed training duration in seconds, not elapsed training time.
  
  minimum = 900, maximum = 21600
  
  preprocessedInsights array of objects
  
  Preprocessed insights. Like feature insights but with fewer details.
  
  Show preprocessedInsights properties
  
  name string
  
  Required
  
  Name of the preprocessed insight column
  
  insights array of strings
  
  Required
  
  Preliminary list of column/feature insights available after preprocessing but before feature insights are available
  
  Values may be any of: "is_free_text""cannot_be_processed_as_free_text""is_date_engineered""has_target_leakage""feature_type_change_invalid""feature_type_change_failed""feature_type_change_successful""data_bias_detected""representation_bias_detected"
  
  willBeDropped boolean
  
  Required
  
  Whether this feature insight will be dropped due to free text or high cardinality that makes it less useful

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/experiments/{experimentId}/versions

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.createMlExperimentVersion(
  'string',
  {
    data: {
      attributes: {
        algorithms: ['catboost_classifier'],
        dataSetId: '672e55cfcadfb8a18281523e',
        datasetOrigin: 'new',
        dateIndexes: ['string'],
        experimentMode: 'intelligent',
        experimentType: 'binary',
        featuresList: [
          {
            dataType: 'STRING',
            featureType: 'categorical',
            include: true,
            name: 'ColumnA',
          },
        ],
        name: 'Experiment version name. Defaults to current date.',
        pipeline: {
          transforms: [
            {
              column: {
                changeType: 'string',
                name: 'string',
              },
            },
          ],
        },
        target: 'TargetColumn',
        trainingDuration: 900,
      },
      type: 'experiment-version',
    },
  },
)

qlik ml experiment version create \
  --experimentId 'string' \
  --data-attributes-algorithms 'catboost_classifier' \
  --data-attributes-dataSetId '672e55cfcadfb8a18281523e' \
  --data-attributes-datasetOrigin 'new' \
  --data-attributes-dateIndexes 'string' \
  --data-attributes-experimentMode 'intelligent' \
  --data-attributes-experimentType 'binary' \
  --data-attributes-featuresList-changeType '' \
  --data-attributes-featuresList-dataType '' \
  --data-attributes-featuresList-featureType '' \
  --data-attributes-featuresList-include  \
  --data-attributes-featuresList-name '' \
  --data-attributes-featuresList-parentFeature '' \
  --data-attributes-name 'Experiment version name. Defaults to current date.' \
  --data-attributes-pipeline-transforms-column-changeType '' \
  --data-attributes-pipeline-transforms-column-name '' \
  --data-attributes-target 'TargetColumn' \
  --data-attributes-trainingDuration 900 \
  --data-type 'experiment-version'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}/versions" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"experiment-version","attributes":{"name":"Experiment version name. Defaults to current date.","target":"TargetColumn","pipeline":{"transforms":[{"column":{"name":"string","changeType":"string"}}]},"dataSetId":"672e55cfcadfb8a18281523e","algorithms":["catboost_classifier"],"dateIndexes":["string"],"featuresList":[{"name":"ColumnA","include":true,"dataType":"STRING","changeType":null,"featureType":"categorical","parentFeature":null}],"datasetOrigin":"new","experimentMode":"intelligent","experimentType":"binary","trainingDuration":900,"maxTrainingDuration":900}}}'

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "experiment-version",
    "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",
      "status": "pending",
      "target": "TargetColumn",
      "pipeline": {
        "transforms": [
          {
            "column": {
              "name": "string",
              "changeType": "string"
            }
          }
        ]
      },
      "createdAt": "string",
      "dataSetId": "672e55cfcadfb8a18281523e",
      "profileId": "string",
      "updatedAt": "string",
      "algorithms": [
        "catboost_classifier"
      ],
      "topModelId": "string",
      "dateIndexes": [
        "string"
      ],
      "errorMessage": "string",
      "experimentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "featuresList": [
        {
          "name": "ColumnA",
          "include": true,
          "dataType": "STRING",
          "changeType": null,
          "featureType": "categorical",
          "parentFeature": null
        }
      ],
      "lastBatchNum": 42,
      "datasetOrigin": "new",
      "versionNumber": 42,
      "experimentMode": "intelligent",
      "experimentType": "binary",
      "createdByUserId": "string",
      "trainingDuration": 900,
      "maxTrainingDuration": 900,
      "preprocessedInsights": [
        {
          "name": "string",
          "insights": [],
          "willBeDropped": true
        }
      ]
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment
experimentVersionId string

Required

ID of the experiment version

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "experiment-version"
  
  attributes object
  
  Required
  
  An AutoML experiment version. This is a configuration for training models within an experiment.
  
  Show attributes properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  name string
  
  Filterable
  
  Name of this entity
  
  errors array of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
  
  status string
  
  Required Filterable
  
  Current status of this entity
  
  Can be one of: "ready""error""cancelled""pending""dataprep_requested""datasync_requested""datasync_done"
  default = "pending"
  
  target string
  
  Required
  
  The target field in the dataset
  
  pipeline object
  
  Pipeline metadata including transformations to apply to columns and specific schema configuration data
  
  Show pipeline properties
  
  transforms array of objects
  
  Show transforms properties
  
  column object
  
  Show column properties
  
  name string
  
  Required
  
  changeType string
  
  Required
  
  createdAt string
  
  Required
  
  Timestamp when this was created
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  profileId string
  
  ID of the dataset profile with metadata about source data
  
  updatedAt string
  
  Required
  
  Timestamp when this was updated
  
  algorithms array of strings
  
  List of algorithms selected for model training in this version
  
  Values may be any of: "catboost_classifier""catboost_regression""elasticnet_regression""gaussian_nb""kneighbors_classifier""lasso_regression""lasso""lgbm_classifier""lgbm_regression""linear_regression""logistic_regression""random_forest_classifier""random_forest_regression""sgd_regression""xgb_classifier""xgb_regression"
  
  topModelId string
  
  ID of the top model (based on training scores) in this experiment version
  
  dateIndexes array of strings
  
  A optional date column name to index
  
  minItems = 0, maxItems = 1
  
  errorMessage string
  
  JSON string of error object
  
  experimentId string
  
  Required
  
  ID of the experiment
  
  format = "uuid"
  
  featuresList array of objects
  
  List of features from your dataset for creating Experiment Versions. This appears in from ProfileInsights response (in the defaultVersionConfig). You can adjust the default settings before using it as input to create or update Experiment Versions.
  
  Show featuresList properties
  
  name string
  
  Name of the feature column
  
  include boolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataType string
  
  The data type of this feature in your dataset
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM""FLOAT""OBJECT"
  
  changeType string
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  parentFeature string
  
  The parent feature name for engineered features. e.g. OrderDate may be the parent of its engineered features (features extracted from parent) like OrderDate.YEAR, OrderDate.MONTH, etc.
  
  lastBatchNum integer
  
  Number of the last batch
  
  datasetOrigin string
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  default = "new"
  
  versionNumber integer
  
  -based sequential version number within the experiment
  
  experimentMode string
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  default = "intelligent"
  
  experimentType string
  
  Required
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"
  
  createdByUserId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  trainingDuration integer
  
  Maximum allowed training duration in seconds, not elapsed training time.
  
  minimum = 900, maximum = 21600
  
  maxTrainingDuration integer
  
  Maximum allowed training duration in seconds, not elapsed training time.
  
  minimum = 900, maximum = 21600
  
  preprocessedInsights array of objects
  
  Preprocessed insights. Like feature insights but with fewer details.
  
  Show preprocessedInsights properties
  
  name string
  
  Required
  
  Name of the preprocessed insight column
  
  insights array of strings
  
  Required
  
  Preliminary list of column/feature insights available after preprocessing but before feature insights are available
  
  Values may be any of: "is_free_text""cannot_be_processed_as_free_text""is_date_engineered""has_target_leakage""feature_type_change_invalid""feature_type_change_failed""feature_type_change_successful""data_bias_detected""representation_bias_detected"
  
  willBeDropped boolean
  
  Required
  
  Whether this feature insight will be dropped due to free text or high cardinality that makes it less useful

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlExperimentVersion(
  'string',
  'string',
)

qlik ml experiment version get 'string' \
  --experimentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "experiment-version",
    "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",
      "status": "pending",
      "target": "TargetColumn",
      "pipeline": {
        "transforms": [
          {
            "column": {
              "name": "string",
              "changeType": "string"
            }
          }
        ]
      },
      "createdAt": "string",
      "dataSetId": "672e55cfcadfb8a18281523e",
      "profileId": "string",
      "updatedAt": "string",
      "algorithms": [
        "catboost_classifier"
      ],
      "topModelId": "string",
      "dateIndexes": [
        "string"
      ],
      "errorMessage": "string",
      "experimentId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "featuresList": [
        {
          "name": "ColumnA",
          "include": true,
          "dataType": "STRING",
          "changeType": null,
          "featureType": "categorical",
          "parentFeature": null
        }
      ],
      "lastBatchNum": 42,
      "datasetOrigin": "new",
      "versionNumber": 42,
      "experimentMode": "intelligent",
      "experimentType": "binary",
      "createdByUserId": "string",
      "trainingDuration": 900,
      "maxTrainingDuration": 900,
      "preprocessedInsights": [
        {
          "name": "string",
          "insights": [],
          "willBeDropped": true
        }
      ]
    }
  }
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment
experimentVersionId string

Required

ID of the experiment version

Request Body

application/json array of objects

Values that can be patched.
Show application/json properties
- op string
  
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- path string
  
  Required
  
  Path for the properties you can update.
  
  Can be one of: "/name"
- value any
  
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

PATCH /api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.patchMlExperimentVersion(
  'string',
  'string',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'New name',
    },
  ],
)

qlik ml experiment version patch 'string' \
  --experimentId 'string' \
  --op 'replace' \
  --path '/name' \
  --value New name

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"New name"}]'

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

experimentId string

Required

ID of the experiment
experimentVersionId string

Required

ID of the experiment version

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

DELETE /api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.deleteMlExperimentVersion(
  'string',
  'string',
)

qlik ml experiment version rm 'string' \
  --experimentId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Cancels jobs for an experiment version or batch prediction.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

corrType string

Required

The type of a resource paired with a corrId

Can be one of: "batch-prediction""experiment-version"
corrId string

Required

The ID of a correlated resource of corrType

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

405

Method Not Allowed

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/jobs/{corrType}/{corrId}/actions/cancel

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.cancelMlJob(
  'batch-prediction',
  'string',
)

qlik ml cancel-job \
  --corrType 'batch-prediction' \
  --jobId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/jobs/{corrType}/{corrId}/actions/cancel" \
-X POST \
-H "Authorization: Bearer <access_token>"

Starts creating profile insights for an experiment dataset. This is an asynchronous operation. A 202 Accepted response indicates that the process has started successfully. Use the link in the response to check the status.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

application/json object

Input to get dataset and feature metadata needed to create experiment versions
Show application/json properties
- data object
  
  Data wrapper for request input
  
  Show data properties
  
  type string
  
  Can be one of: "profile-insights"
  default = "profile-insights"
  
  attributes object
  
  The request body for this resource
  
  Show attributes properties
  
  target string
  
  Optional selected target provided on subsequent requests
  
  include string
  
  Fields to include in the response.
  
  Currently only supported value is dataSetProfile.
  
  When dataSetProfile is specified, the response includes the full dataset profile.
  
  Can be one of: "dataSetProfile"
  
  dataSetId string
  
  The Qlik catalog dataset ID
  
  shouldWait boolean
  
  Whether the server should or client should manage polling/waiting
  
  default = false
  
  experimentType string
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "profile-insights"
  
  attributes object
  
  Required
  
  Insights (metadata) about an experiment dataset
  
  Show attributes properties
  
  status string
  
  Required
  
  Status of profile insights. Not available until ready.
  
  Can be one of: "pending""error""ready"
  default = "pending"
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  insights array of objects
  
  List of feature insights object, one per feature in the dataset
  
  Show insights properties
  
  name string
  
  Required
  
  Name of the feature insight
  
  insights array of strings
  
  Required
  
  List of insights about this feature.
  
  Values may be any of: "constant""high_cardinality""high_cardinality_integer""too_many_nulls""will_be_impact_encoded""will_be_one_hot_encoded""possible_free_text_encoded""valid_index""underrepresented_class""invalid_column_name""will_be_date_engineered"
  
  willBeDropped boolean
  
  Required
  
  Whether this feature will be dropped. Traits like high cardinality make some features less predictive or too costly to merit use.
  
  cannotBeTarget boolean
  
  Required
  
  Whether a feature cannot be the target field
  
  experimentTypes array of strings
  
  Required
  
  Experiment types in this feature insight
  
  Values may be any of: "binary""multiclass""regression"
  
  defaultFeatureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  engineeredFeatures array of strings
  
  Preliminary list of engineered features as strings. If subsequent processing validates them, they'll be converted to EngineeredFeature objects within a NestedColumn, each of which may contain its own FeatureInsights.
  
  estimatedMaxForecastHorizon integer
  
  Only applies for time series experiment types. This intial estimate of the combined max forecast window and gap (aka - horizon). It only applies to possible date index columns. After the experiment version is created, we get a more precise number for subsequent versions. When training data is grouped, this estimate may be less accurate.
  
  tenantId string
  
  Required Filterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  algorithms array of strings
  
  List of algorithms available for the selected experiment type
  
  Values may be any of: "catboost_classifier""catboost_regression""elasticnet_regression""gaussian_nb""kneighbors_classifier""lasso_regression""lasso""lgbm_classifier""lgbm_regression""linear_regression""logistic_regression""random_forest_classifier""random_forest_regression""sgd_regression""xgb_classifier""xgb_regression"
  
  isLargeCsv boolean
  
  Is this a CSV dataset > 1GB?
  
  sizeInBytes integer
  
  Size of the profiled dataset in bytes.
  
  numberOfRows number
  
  Number of rows in the dataset.
  
  When isLargeCsv is true, this is an estimate since their metadata is based on a sample rather than the full dataset.
  
  For datasets over 1GB, multiply rows (this) by columns (features included in experiment version) to calculate total cells to ensure it stays under your license limit. Large CSVs have a hard 100. M cell limit.
  
  dataSetProfile object
  
  Full dataset profile from the Profile Service.
  
  Show dataSetProfile properties
  
  meta object
  
  Required
  
  Metadata about a dataset profile computation.
  
  Show meta properties
  
  status string
  
  Required
  
  Can be one of: "FINISHED""PARTIAL""QUEUED""RUNNING""STALE""CANCELLED""FAILED""INCOMPLETE""DEFERRED"
  
  messages array of strings
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  resultType string
  
  Can be one of: "NORMAL""BASIC""BASIC_TOO_LARGE"
  
  connectionId string
  
  lastLoadTime string
  
  maxSizeBytes number
  
  computationEndTime string
  
  computationStartTime string
  
  samples array of objects
  
  Sample values from a table/dataset.
  
  Show samples properties
  
  name string
  
  records array of objects
  
  A single record of sample values.
  
  Show records properties
  
  values array of strings
  
  fieldNames array of strings
  
  profiles array of objects
  
  Profile metadata for a single table/dataset.
  
  Show profiles properties
  
  name string
  
  Required
  
  sizeInBytes number
  
  numberOfRows integer
  
  Required
  
  fieldProfiles array of objects
  
  Required
  
  Profile metadata for a single field/column.
  
  Show fieldProfiles properties
  
  name string
  
  tags array of strings
  
  index integer
  
  median number
  
  average number
  
  dataType string
  
  kurtosis number
  
  skewness number
  
  fractiles array of numbers
  
  sampleValues array of strings
  
  technicalName string
  
  classification object
  
  Classification metadata for a field.
  
  Show classification properties
  
  pii boolean
  
  tags array of objects
  
  A classification tag with a confidence score.
  
  Show tags properties
  
  tag string
  
  score number
  
  sensitive boolean
  
  obfuscation string
  
  nullValueCount integer
  
  textValueCount integer
  
  zeroValueCount integer
  
  maxNumericValue number
  
  maxStringLength integer
  
  minNumericValue number
  
  minStringLength integer
  
  sumStringLength integer
  
  emptyStringCount integer
  
  sumNumericValues number
  
  numericValueCount integer
  
  standardDeviation number
  
  distinctValueCount integer
  
  mostFrequentValues array of objects
  
  A value and its frequency count.
  
  Show mostFrequentValues properties
  
  value string
  
  frequency number
  
  negativeValueCount integer
  
  positiveValueCount integer
  
  averageStringLength number
  
  frequencyDistribution array of objects
  
  A frequency bin in a field's frequency distribution.
  
  Show frequencyDistribution properties
  
  binEdge number
  
  frequency number
  
  lastSortedStringValue string
  
  firstSortedStringValue string
  
  sumSquaredNumericValues number
  
  experimentVersionId string
  
  Optional experiment version ID. When included, it indicates that this dataset profile is a snapshot from a previous version.
  
  defaultVersionConfig object
  
  Default configuration for creating an experiment version from this dataset. Not returned when experimentVersionId is provided.
  
  Show defaultVersionConfig properties
  
  name string
  
  Required
  
  default = "Experiment version name. Defaults to current date/time."
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  featuresList array of objects
  
  List of features from your dataset for creating Experiment Versions. This appears in from ProfileInsights response (in the defaultVersionConfig). You can adjust the default settings before using it as input to create or update Experiment Versions.
  
  Show featuresList properties
  
  name string
  
  Name of the feature column
  
  include boolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataType string
  
  The data type of this feature in your dataset
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM""FLOAT""OBJECT"
  
  changeType string
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  parentFeature string
  
  The parent feature name for engineered features. e.g. OrderDate may be the parent of its engineered features (features extracted from parent) like OrderDate.YEAR, OrderDate.MONTH, etc.
  
  datasetOrigin string
  
  Required
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  default = "new"
  
  experimentMode string
  
  Required
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  default = "intelligent"

202

Accepted

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "profile-insights"
  
  attributes object
  
  Required
  
  Insights (metadata) about an experiment dataset
  
  Show attributes properties
  
  status string
  
  Required
  
  Status of profile insights. Not available until ready.
  
  Can be one of: "pending""error""ready"
  default = "pending"
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  insights array of objects
  
  List of feature insights object, one per feature in the dataset
  
  Show insights properties
  
  name string
  
  Required
  
  Name of the feature insight
  
  insights array of strings
  
  Required
  
  List of insights about this feature.
  
  Values may be any of: "constant""high_cardinality""high_cardinality_integer""too_many_nulls""will_be_impact_encoded""will_be_one_hot_encoded""possible_free_text_encoded""valid_index""underrepresented_class""invalid_column_name""will_be_date_engineered"
  
  willBeDropped boolean
  
  Required
  
  Whether this feature will be dropped. Traits like high cardinality make some features less predictive or too costly to merit use.
  
  cannotBeTarget boolean
  
  Required
  
  Whether a feature cannot be the target field
  
  experimentTypes array of strings
  
  Required
  
  Experiment types in this feature insight
  
  Values may be any of: "binary""multiclass""regression"
  
  defaultFeatureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  engineeredFeatures array of strings
  
  Preliminary list of engineered features as strings. If subsequent processing validates them, they'll be converted to EngineeredFeature objects within a NestedColumn, each of which may contain its own FeatureInsights.
  
  estimatedMaxForecastHorizon integer
  
  Only applies for time series experiment types. This intial estimate of the combined max forecast window and gap (aka - horizon). It only applies to possible date index columns. After the experiment version is created, we get a more precise number for subsequent versions. When training data is grouped, this estimate may be less accurate.
  
  tenantId string
  
  Required Filterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  algorithms array of strings
  
  List of algorithms available for the selected experiment type
  
  Values may be any of: "catboost_classifier""catboost_regression""elasticnet_regression""gaussian_nb""kneighbors_classifier""lasso_regression""lasso""lgbm_classifier""lgbm_regression""linear_regression""logistic_regression""random_forest_classifier""random_forest_regression""sgd_regression""xgb_classifier""xgb_regression"
  
  isLargeCsv boolean
  
  Is this a CSV dataset > 1GB?
  
  sizeInBytes integer
  
  Size of the profiled dataset in bytes.
  
  numberOfRows number
  
  Number of rows in the dataset.
  
  When isLargeCsv is true, this is an estimate since their metadata is based on a sample rather than the full dataset.
  
  For datasets over 1GB, multiply rows (this) by columns (features included in experiment version) to calculate total cells to ensure it stays under your license limit. Large CSVs have a hard 100. M cell limit.
  
  dataSetProfile object
  
  Full dataset profile from the Profile Service.
  
  Show dataSetProfile properties
  
  meta object
  
  Required
  
  Metadata about a dataset profile computation.
  
  Show meta properties
  
  status string
  
  Required
  
  Can be one of: "FINISHED""PARTIAL""QUEUED""RUNNING""STALE""CANCELLED""FAILED""INCOMPLETE""DEFERRED"
  
  messages array of strings
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  resultType string
  
  Can be one of: "NORMAL""BASIC""BASIC_TOO_LARGE"
  
  connectionId string
  
  lastLoadTime string
  
  maxSizeBytes number
  
  computationEndTime string
  
  computationStartTime string
  
  samples array of objects
  
  Sample values from a table/dataset.
  
  Show samples properties
  
  name string
  
  records array of objects
  
  A single record of sample values.
  
  Show records properties
  
  values array of strings
  
  fieldNames array of strings
  
  profiles array of objects
  
  Profile metadata for a single table/dataset.
  
  Show profiles properties
  
  name string
  
  Required
  
  sizeInBytes number
  
  numberOfRows integer
  
  Required
  
  fieldProfiles array of objects
  
  Required
  
  Profile metadata for a single field/column.
  
  Show fieldProfiles properties
  
  name string
  
  tags array of strings
  
  index integer
  
  median number
  
  average number
  
  dataType string
  
  kurtosis number
  
  skewness number
  
  fractiles array of numbers
  
  sampleValues array of strings
  
  technicalName string
  
  classification object
  
  Classification metadata for a field.
  
  Show classification properties
  
  pii boolean
  
  tags array of objects
  
  A classification tag with a confidence score.
  
  Show tags properties
  
  tag string
  
  score number
  
  sensitive boolean
  
  obfuscation string
  
  nullValueCount integer
  
  textValueCount integer
  
  zeroValueCount integer
  
  maxNumericValue number
  
  maxStringLength integer
  
  minNumericValue number
  
  minStringLength integer
  
  sumStringLength integer
  
  emptyStringCount integer
  
  sumNumericValues number
  
  numericValueCount integer
  
  standardDeviation number
  
  distinctValueCount integer
  
  mostFrequentValues array of objects
  
  A value and its frequency count.
  
  Show mostFrequentValues properties
  
  value string
  
  frequency number
  
  negativeValueCount integer
  
  positiveValueCount integer
  
  averageStringLength number
  
  frequencyDistribution array of objects
  
  A frequency bin in a field's frequency distribution.
  
  Show frequencyDistribution properties
  
  binEdge number
  
  frequency number
  
  lastSortedStringValue string
  
  firstSortedStringValue string
  
  sumSquaredNumericValues number
  
  experimentVersionId string
  
  Optional experiment version ID. When included, it indicates that this dataset profile is a snapshot from a previous version.
  
  defaultVersionConfig object
  
  Default configuration for creating an experiment version from this dataset. Not returned when experimentVersionId is provided.
  
  Show defaultVersionConfig properties
  
  name string
  
  Required
  
  default = "Experiment version name. Defaults to current date/time."
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  featuresList array of objects
  
  List of features from your dataset for creating Experiment Versions. This appears in from ProfileInsights response (in the defaultVersionConfig). You can adjust the default settings before using it as input to create or update Experiment Versions.
  
  Show featuresList properties
  
  name string
  
  Name of the feature column
  
  include boolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataType string
  
  The data type of this feature in your dataset
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM""FLOAT""OBJECT"
  
  changeType string
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  parentFeature string
  
  The parent feature name for engineered features. e.g. OrderDate may be the parent of its engineered features (features extracted from parent) like OrderDate.YEAR, OrderDate.MONTH, etc.
  
  datasetOrigin string
  
  Required
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  default = "new"
  
  experimentMode string
  
  Required
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  default = "intelligent"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

POST /api/v1/ml/profile-insights

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.createMlProfileInsight({
  data: {
    attributes: {
      dataSetId: '672e55cfcadfb8a18281523e',
      experimentType: 'binary',
      include: 'dataSetProfile',
      target: 'string',
    },
    type: 'profile-insights',
  },
})

qlik ml profile-insight create

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/profile-insights" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"profile-insights","attributes":{"target":"string","include":"dataSetProfile","dataSetId":"672e55cfcadfb8a18281523e","shouldWait":false,"experimentType":"binary"}}}'

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "profile-insights",
    "attributes": {
      "status": "pending",
      "ownerId": "string",
      "insights": [
        {
          "name": "string",
          "insights": [
            "constant"
          ],
          "willBeDropped": true,
          "cannotBeTarget": true,
          "experimentTypes": [
            "binary"
          ],
          "defaultFeatureType": "categorical",
          "engineeredFeatures": "[\n  `${featureName}.YEAR`,\n  `${featureName}.MONTH`\n]\n",
          "estimatedMaxForecastHorizon": 42
        }
      ],
      "tenantId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "algorithms": [
        "catboost_classifier"
      ],
      "isLargeCsv": true,
      "sizeInBytes": 42,
      "numberOfRows": 42,
      "dataSetProfile": {
        "meta": {
          "status": "FINISHED",
          "messages": [
            "string"
          ],
          "dataSetId": "672e55cfcadfb8a18281523e",
          "resultType": "NORMAL",
          "connectionId": "string",
          "lastLoadTime": "string",
          "maxSizeBytes": 42,
          "computationEndTime": "string",
          "computationStartTime": "string"
        },
        "samples": [
          {
            "name": "string",
            "records": [
              {
                "values": [
                  "string"
                ]
              }
            ],
            "fieldNames": [
              "string"
            ]
          }
        ],
        "profiles": [
          {
            "name": "string",
            "sizeInBytes": 42,
            "numberOfRows": 42,
            "fieldProfiles": [
              {
                "name": "string",
                "tags": [
                  "string"
                ],
                "index": 42,
                "median": 42,
                "average": 42,
                "dataType": "string",
                "kurtosis": 42,
                "skewness": 42,
                "fractiles": [
                  42
                ],
                "sampleValues": [
                  "string"
                ],
                "technicalName": "string",
                "classification": {
                  "pii": true,
                  "tags": [
                    {
                      "tag": "string",
                      "score": 42
                    }
                  ],
                  "sensitive": true,
                  "obfuscation": "string"
                },
                "nullValueCount": 42,
                "textValueCount": 42,
                "zeroValueCount": 42,
                "maxNumericValue": 42,
                "maxStringLength": 42,
                "minNumericValue": 42,
                "minStringLength": 42,
                "sumStringLength": 42,
                "emptyStringCount": 42,
                "sumNumericValues": 42,
                "numericValueCount": 42,
                "standardDeviation": 42,
                "distinctValueCount": 42,
                "mostFrequentValues": [
                  {
                    "value": "string",
                    "frequency": 42
                  }
                ],
                "negativeValueCount": 42,
                "positiveValueCount": 42,
                "averageStringLength": 42,
                "frequencyDistribution": [
                  {
                    "binEdge": 42,
                    "frequency": 42
                  }
                ],
                "lastSortedStringValue": "string",
                "firstSortedStringValue": "string",
                "sumSquaredNumericValues": 42
              }
            ]
          }
        ]
      },
      "experimentVersionId": "string",
      "defaultVersionConfig": {
        "name": "Experiment version name. Defaults to current date/time.",
        "dataSetId": "672e55cfcadfb8a18281523e",
        "featuresList": [
          {
            "name": "ColumnA",
            "include": true,
            "dataType": "STRING",
            "changeType": null,
            "featureType": "categorical",
            "parentFeature": null
          }
        ],
        "datasetOrigin": "new",
        "experimentMode": "intelligent"
      }
    }
  }
}

Retrieves profile insights for the specified dataset. If you received a 202 Accepted response from POST /ml/profile-insights, poll this endpoint until a 200 OK response with ready status is returned.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

experimentVersionId string

The optional experimentVersionId query parameter for profile-insights GET requests. When provided after a version has been trained, it gets the profile insights snapshot used in previous versions rather than new results.
target string

The optional target feature for profile-insights GET requests after this is known.
experimentType string

The optional experiment type for profile-insights GET requests after this is known.

Can be one of: "binary""multiclass""regression"

Path Parameters

dataSetId string

Required

The Qlik catalog dataset ID

Responses

200

OK

application/json object
Show application/json properties
- data object
  
  Required
  
  Show data properties
  
  id string
  
  Required Filterable
  
  ID of this entity
  
  format = "uuid"
  
  type string
  
  Required
  
  Can be one of: "profile-insights"
  
  attributes object
  
  Required
  
  Insights (metadata) about an experiment dataset
  
  Show attributes properties
  
  status string
  
  Required
  
  Status of profile insights. Not available until ready.
  
  Can be one of: "pending""error""ready"
  default = "pending"
  
  ownerId string
  
  Required Filterable
  
  ID of owner/user for this entity
  
  insights array of objects
  
  List of feature insights object, one per feature in the dataset
  
  Show insights properties
  
  name string
  
  Required
  
  Name of the feature insight
  
  insights array of strings
  
  Required
  
  List of insights about this feature.
  
  Values may be any of: "constant""high_cardinality""high_cardinality_integer""too_many_nulls""will_be_impact_encoded""will_be_one_hot_encoded""possible_free_text_encoded""valid_index""underrepresented_class""invalid_column_name""will_be_date_engineered"
  
  willBeDropped boolean
  
  Required
  
  Whether this feature will be dropped. Traits like high cardinality make some features less predictive or too costly to merit use.
  
  cannotBeTarget boolean
  
  Required
  
  Whether a feature cannot be the target field
  
  experimentTypes array of strings
  
  Required
  
  Experiment types in this feature insight
  
  Values may be any of: "binary""multiclass""regression"
  
  defaultFeatureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  engineeredFeatures array of strings
  
  Preliminary list of engineered features as strings. If subsequent processing validates them, they'll be converted to EngineeredFeature objects within a NestedColumn, each of which may contain its own FeatureInsights.
  
  estimatedMaxForecastHorizon integer
  
  Only applies for time series experiment types. This intial estimate of the combined max forecast window and gap (aka - horizon). It only applies to possible date index columns. After the experiment version is created, we get a more precise number for subsequent versions. When training data is grouped, this estimate may be less accurate.
  
  tenantId string
  
  Required Filterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  algorithms array of strings
  
  List of algorithms available for the selected experiment type
  
  Values may be any of: "catboost_classifier""catboost_regression""elasticnet_regression""gaussian_nb""kneighbors_classifier""lasso_regression""lasso""lgbm_classifier""lgbm_regression""linear_regression""logistic_regression""random_forest_classifier""random_forest_regression""sgd_regression""xgb_classifier""xgb_regression"
  
  isLargeCsv boolean
  
  Is this a CSV dataset > 1GB?
  
  sizeInBytes integer
  
  Size of the profiled dataset in bytes.
  
  numberOfRows number
  
  Number of rows in the dataset.
  
  When isLargeCsv is true, this is an estimate since their metadata is based on a sample rather than the full dataset.
  
  For datasets over 1GB, multiply rows (this) by columns (features included in experiment version) to calculate total cells to ensure it stays under your license limit. Large CSVs have a hard 100. M cell limit.
  
  dataSetProfile object
  
  Full dataset profile from the Profile Service.
  
  Show dataSetProfile properties
  
  meta object
  
  Required
  
  Metadata about a dataset profile computation.
  
  Show meta properties
  
  status string
  
  Required
  
  Can be one of: "FINISHED""PARTIAL""QUEUED""RUNNING""STALE""CANCELLED""FAILED""INCOMPLETE""DEFERRED"
  
  messages array of strings
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  resultType string
  
  Can be one of: "NORMAL""BASIC""BASIC_TOO_LARGE"
  
  connectionId string
  
  lastLoadTime string
  
  maxSizeBytes number
  
  computationEndTime string
  
  computationStartTime string
  
  samples array of objects
  
  Sample values from a table/dataset.
  
  Show samples properties
  
  name string
  
  records array of objects
  
  A single record of sample values.
  
  Show records properties
  
  values array of strings
  
  fieldNames array of strings
  
  profiles array of objects
  
  Profile metadata for a single table/dataset.
  
  Show profiles properties
  
  name string
  
  Required
  
  sizeInBytes number
  
  numberOfRows integer
  
  Required
  
  fieldProfiles array of objects
  
  Required
  
  Profile metadata for a single field/column.
  
  Show fieldProfiles properties
  
  name string
  
  tags array of strings
  
  index integer
  
  median number
  
  average number
  
  dataType string
  
  kurtosis number
  
  skewness number
  
  fractiles array of numbers
  
  sampleValues array of strings
  
  technicalName string
  
  classification object
  
  Classification metadata for a field.
  
  Show classification properties
  
  pii boolean
  
  tags array of objects
  
  A classification tag with a confidence score.
  
  Show tags properties
  
  tag string
  
  score number
  
  sensitive boolean
  
  obfuscation string
  
  nullValueCount integer
  
  textValueCount integer
  
  zeroValueCount integer
  
  maxNumericValue number
  
  maxStringLength integer
  
  minNumericValue number
  
  minStringLength integer
  
  sumStringLength integer
  
  emptyStringCount integer
  
  sumNumericValues number
  
  numericValueCount integer
  
  standardDeviation number
  
  distinctValueCount integer
  
  mostFrequentValues array of objects
  
  A value and its frequency count.
  
  Show mostFrequentValues properties
  
  value string
  
  frequency number
  
  negativeValueCount integer
  
  positiveValueCount integer
  
  averageStringLength number
  
  frequencyDistribution array of objects
  
  A frequency bin in a field's frequency distribution.
  
  Show frequencyDistribution properties
  
  binEdge number
  
  frequency number
  
  lastSortedStringValue string
  
  firstSortedStringValue string
  
  sumSquaredNumericValues number
  
  experimentVersionId string
  
  Optional experiment version ID. When included, it indicates that this dataset profile is a snapshot from a previous version.
  
  defaultVersionConfig object
  
  Default configuration for creating an experiment version from this dataset. Not returned when experimentVersionId is provided.
  
  Show defaultVersionConfig properties
  
  name string
  
  Required
  
  default = "Experiment version name. Defaults to current date/time."
  
  dataSetId string
  
  Required
  
  The Qlik catalog dataset ID
  
  featuresList array of objects
  
  List of features from your dataset for creating Experiment Versions. This appears in from ProfileInsights response (in the defaultVersionConfig). You can adjust the default settings before using it as input to create or update Experiment Versions.
  
  Show featuresList properties
  
  name string
  
  Name of the feature column
  
  include boolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataType string
  
  The data type of this feature in your dataset
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM""FLOAT""OBJECT"
  
  changeType string
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureType string
  
  The default feature type based on the feature's data type. If you want a value to be interpreted differently (e.g. 0/1 as categorical/boolean instead of numeric), use changeType.
  
  Can be one of: "categorical""numeric""date""freetext"
  
  parentFeature string
  
  The parent feature name for engineered features. e.g. OrderDate may be the parent of its engineered features (features extracted from parent) like OrderDate.YEAR, OrderDate.MONTH, etc.
  
  datasetOrigin string
  
  Required
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  default = "new"
  
  experimentMode string
  
  Required
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  default = "intelligent"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

500

Internal Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

502

Bad Gateway

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

default

Unexpected Error

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  code string
  
  Required
  
  Qlik error code (not HTTP response status code)
  
  meta object
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issue string
  
  The issue code
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  title string
  
  Required
  
  Short summary of error
  
  detail string
  
  Description of the error
- traceId string

GET /api/v1/ml/profile-insights/{dataSetId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.ml.getMlProfileInsight(
  '672e55cfcadfb8a18281523e',
)

qlik ml profile-insight get '672e55cfcadfb8a18281523e'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/ml/profile-insights/{dataSetId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "profile-insights",
    "attributes": {
      "status": "pending",
      "ownerId": "string",
      "insights": [
        {
          "name": "string",
          "insights": [
            "constant"
          ],
          "willBeDropped": true,
          "cannotBeTarget": true,
          "experimentTypes": [
            "binary"
          ],
          "defaultFeatureType": "categorical",
          "engineeredFeatures": "[\n  `${featureName}.YEAR`,\n  `${featureName}.MONTH`\n]\n",
          "estimatedMaxForecastHorizon": 42
        }
      ],
      "tenantId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "algorithms": [
        "catboost_classifier"
      ],
      "isLargeCsv": true,
      "sizeInBytes": 42,
      "numberOfRows": 42,
      "dataSetProfile": {
        "meta": {
          "status": "FINISHED",
          "messages": [
            "string"
          ],
          "dataSetId": "672e55cfcadfb8a18281523e",
          "resultType": "NORMAL",
          "connectionId": "string",
          "lastLoadTime": "string",
          "maxSizeBytes": 42,
          "computationEndTime": "string",
          "computationStartTime": "string"
        },
        "samples": [
          {
            "name": "string",
            "records": [
              {
                "values": [
                  "string"
                ]
              }
            ],
            "fieldNames": [
              "string"
            ]
          }
        ],
        "profiles": [
          {
            "name": "string",
            "sizeInBytes": 42,
            "numberOfRows": 42,
            "fieldProfiles": [
              {
                "name": "string",
                "tags": [
                  "string"
                ],
                "index": 42,
                "median": 42,
                "average": 42,
                "dataType": "string",
                "kurtosis": 42,
                "skewness": 42,
                "fractiles": [
                  42
                ],
                "sampleValues": [
                  "string"
                ],
                "technicalName": "string",
                "classification": {
                  "pii": true,
                  "tags": [
                    {
                      "tag": "string",
                      "score": 42
                    }
                  ],
                  "sensitive": true,
                  "obfuscation": "string"
                },
                "nullValueCount": 42,
                "textValueCount": 42,
                "zeroValueCount": 42,
                "maxNumericValue": 42,
                "maxStringLength": 42,
                "minNumericValue": 42,
                "minStringLength": 42,
                "sumStringLength": 42,
                "emptyStringCount": 42,
                "sumNumericValues": 42,
                "numericValueCount": 42,
                "standardDeviation": 42,
                "distinctValueCount": 42,
                "mostFrequentValues": [
                  {
                    "value": "string",
                    "frequency": 42
                  }
                ],
                "negativeValueCount": 42,
                "positiveValueCount": 42,
                "averageStringLength": 42,
                "frequencyDistribution": [
                  {
                    "binEdge": 42,
                    "frequency": 42
                  }
                ],
                "lastSortedStringValue": "string",
                "firstSortedStringValue": "string",
                "sumSquaredNumericValues": 42
              }
            ]
          }
        ]
      },
      "experimentVersionId": "string",
      "defaultVersionConfig": {
        "name": "Experiment version name. Defaults to current date/time.",
        "dataSetId": "672e55cfcadfb8a18281523e",
        "featuresList": [
          {
            "name": "ColumnA",
            "include": true,
            "dataType": "STRING",
            "changeType": null,
            "featureType": "categorical",
            "parentFeature": null
          }
        ],
        "datasetOrigin": "new",
        "experimentMode": "intelligent"
      }
    }
  }
}

Machine Learning

Endpoints

List deployments

Facts

Query Parameters

Responses

200

400

401

403

404

500

502

503

default

Example Response

Create a deployment

Facts

Request Body

Responses

201

400

401

403

500

502

503

default

Example Response

Get a deployment

Facts

Path Parameters

Responses

200

400

401

403

404

500

502

503

default

Example Response

Update a deployment

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

500

502

503

default

Delete a deployment

Facts

Path Parameters

Responses

204

400

401

403

404

500

502

503

default

Activate the model for this deployment

Facts

Path Parameters

Responses

204

400

401

403

404

500