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 specification

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)
Categories

Query Parameters

filterstring
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
sortstring

Field(s) by which to sort response

Can be one of: "createdAt""+createdAt""-createdAt""name""+name""-name""updatedAt""+updatedAt""-updatedAt"
limitinteger

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offsetinteger

Number of rows to skip before getting page[size]

Responses

200

OK

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "deployment"
  
  attributesobject
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  modelIdstring
  RequiredFilterable
  
  ID of the model
  
  format = "uuid"
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  RequiredFilterable
  
  ID of the owner/user that created this entity.
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deprecatedboolean
  Required
  
  Whether this deployment is deprecated
  
  descriptionstring
  Required
  
  Description of this entity
  
  errorMessagestring
  
  JSON string of error object
  
  deployedModelIdsarray of strings
  
  IDs of all models deployed to the deployment
  
  enablePredictionsboolean
  RequiredFilterable
  
  Whether to allow predictions
- metaobject
  
  Meta for FIND operations
  
  Show meta properties
  
  countinteger
  Required
- linksobject
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  lastobject
  Required
  
  Show last properties
  
  hrefstring
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  nextobject
  Required
  
  Show next properties
  
  hrefstring
  
  Link to the next set of responses
  
  format = "uri"
  
  prevobject
  Required
  
  Show prev properties
  
  hrefstring
  
  Link to the previous set of responses
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  
  Link to the current set of responses
  
  format = "uri"
  
  firstobject
  Required
  
  Show first properties
  
  hrefstring
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

GET /api/v1/ml/deployments

import { createQlikApi } from '@qlik/api'

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

await qlik.ml.getMlDeployments({})

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Request Body

application/jsonobject

Input for creating a new deployment
Show application/json properties
- dataobject
  
  Show data properties
  
  typestring
  
  Can be one of: "deployment"
  
  default = "deployment"
  
  attributesobject
  
  Show attributes properties
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  modelIdstring
  RequiredFilterable
  
  ID of the model
  
  format = "uuid"
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  deprecatedboolean
  
  Whether this deployment is deprecated
  
  descriptionstring
  
  Description of this entity
  
  enablePredictionsboolean
  
  Whether to allow real-time predictions

Responses

201

Created

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "deployment"
  
  attributesobject
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  modelIdstring
  RequiredFilterable
  
  ID of the model
  
  format = "uuid"
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  RequiredFilterable
  
  ID of the owner/user that created this entity.
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deprecatedboolean
  Required
  
  Whether this deployment is deprecated
  
  descriptionstring
  Required
  
  Description of this entity
  
  errorMessagestring
  
  JSON string of error object
  
  deployedModelIdsarray of strings
  
  IDs of all models deployed to the deployment
  
  enablePredictionsboolean
  RequiredFilterable
  
  Whether to allow predictions

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

POST /api/v1/ml/deployments

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.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',
  },
})

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "deployment"
  
  attributesobject
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  modelIdstring
  RequiredFilterable
  
  ID of the model
  
  format = "uuid"
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  RequiredFilterable
  
  ID of the owner/user that created this entity.
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deprecatedboolean
  Required
  
  Whether this deployment is deprecated
  
  descriptionstring
  Required
  
  Description of this entity
  
  errorMessagestring
  
  JSON string of error object
  
  deployedModelIdsarray of strings
  
  IDs of all models deployed to the deployment
  
  enablePredictionsboolean
  RequiredFilterable
  
  Whether to allow predictions

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

await qlik.ml.getMlDeployment('string')

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Request Body

application/jsonarray of objects

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

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

await qlik.ml.deleteMlDeployment('string')

This API is not included yet in qlik-cli

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

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

await qlik.ml.activateModelsMlDeployment('string')

This API is not included yet in qlik-cli

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

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Query Parameters

filterstring
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
sortstring

Field(s) by which to sort response

Can be one of: "name""+name""-name"
limitinteger

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offsetinteger

Number of rows to skip before getting page[size]

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

200

OK

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "alias"
  
  attributesobject
  Required
  
  An AutoML alias
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  modestring
  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"
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  modelsarray of objects
  Required
  
  Model information stored on an alias
  
  Show models properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  Required
  
  ID of the owner/user that created this entity
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deploymentIdstring
  Required
  
  ID of a model deployment
  
  format = "uuid"
- metaobject
  
  Meta for FIND operations
  
  Show meta properties
  
  countinteger
  Required
- linksobject
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  lastobject
  Required
  
  Show last properties
  
  hrefstring
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  nextobject
  Required
  
  Show next properties
  
  hrefstring
  
  Link to the next set of responses
  
  format = "uri"
  
  prevobject
  Required
  
  Show prev properties
  
  hrefstring
  
  Link to the previous set of responses
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  
  Link to the current set of responses
  
  format = "uri"
  
  firstobject
  Required
  
  Show first properties
  
  hrefstring
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Request Body

application/jsonobject

Input for creating a new alias
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  typestring
  Required
  
  Can be one of: "alias"
  
  default = "alias"
  
  attributesobject
  Required
  
  Show attributes properties
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  modelsarray of objects
  Required
  
  Model information stored on an alias
  
  Show models properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"

Responses

201

Created

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "alias"
  
  attributesobject
  Required
  
  An AutoML alias
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  modestring
  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"
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  modelsarray of objects
  Required
  
  Model information stored on an alias
  
  Show models properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  Required
  
  ID of the owner/user that created this entity
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deploymentIdstring
  Required
  
  ID of a model deployment
  
  format = "uuid"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
aliasIdstring
Required

ID of the alias

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "alias"
  
  attributesobject
  Required
  
  An AutoML alias
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  modestring
  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"
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  modelsarray of objects
  Required
  
  Model information stored on an alias
  
  Show models properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  Required
  
  ID of the owner/user that created this entity
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deploymentIdstring
  Required
  
  ID of a model deployment
  
  format = "uuid"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
aliasIdstring
Required

ID of the alias

Request Body

application/jsonarray of objects

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

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
aliasIdstring
Required

ID of the alias

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Query Parameters

includeNotPredictedReasonboolean

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

If true, shap values included in response
includeSourceboolean

If true, source data included in response
indexstring

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

deploymentIdstring
Required

ID of the deployment
aliasNamestring
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/jsonobject

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

Responses

200

Stream of combined prediction output returned successfully.

application/jsonobject

Input values for creating realtime predictions
Show application/json properties
- dataobject
  
  Show data properties
  
  typestring
  
  Can be one of: "realtime-prediction"
  
  default = "realtime-prediction"
  
  attributesobject
  
  Show attributes properties
  
  rowsarray of arrays
  
  Rows of the dataset from which to produce predictions
  
  schemaarray of objects
  
  List of features in the dataset
  
  Show schema properties
  
  namestring
  
  The name of a feature in the dataset

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

409

Conflict

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Query Parameters

filterstring
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
sortstring

Field(s) by which to sort response

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

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offsetinteger

Number of rows to skip before getting page[size]

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

200

OK

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "batch-prediction"
  
  attributesobject
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  aliasIdstring
  
  ID of an alias
  
  format = "uuid"
  
  ownerIdstring
  Filterable
  
  ID of owner/user for this entity
  
  scheduleobject
  
  Batch prediction job schedule
  
  Show schedule properties
  
  statusstring
  
  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"
  
  timezonestring
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job finished
  
  chronosJobIdstring
  
  The ID of the chronos job
  
  startDateTimestring
  
  When the job is scheduled to start
  
  failureAttemptsnumber
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  lastSuccessfulDateTimestring
  
  When the last successful job happened
  
  createdAtstring
  
  Timestamp when this was created
  
  createdBystring
  
  ID of the owner/user that ran this prediction batch
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  datasetIdstring
  
  ID of the dataset with the prediction results
  
  updatedAtstring
  
  Timestamp when this was updated
  
  writebackobject
  
  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
  
  formatstring
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  
  default = "parquet"
  
  dstNamestring
  Required
  
  spaceIdstring
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapNamestring
  
  dstSourceNamestring
  
  dstCoordShapNamestring
  
  dstNotPredictedNamestring
  
  indexColumnstring
  
  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.
  
  deploymentIdstring
  
  ID of a model deployment
  
  format = "uuid"
  
  errorMessagestring
  
  JSON string of error object
  
  outputDatasetstring
  
  Where to output dataset
- metaobject
  
  Meta for FIND operations
  
  Show meta properties
  
  countinteger
  Required
- linksobject
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  lastobject
  Required
  
  Show last properties
  
  hrefstring
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  nextobject
  Required
  
  Show next properties
  
  hrefstring
  
  Link to the next set of responses
  
  format = "uri"
  
  prevobject
  Required
  
  Show prev properties
  
  hrefstring
  
  Link to the previous set of responses
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  
  Link to the current set of responses
  
  format = "uri"
  
  firstobject
  Required
  
  Show first properties
  
  hrefstring
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Request Body

application/jsonobject

Input values for creating a batch prediction configuration
Show application/json properties
- dataobject
  
  Show data properties
  
  typestring
  
  Can be one of: "batch-prediction"
  
  default = "batch-prediction"
  
  attributesobject
  
  Show attributes properties
  
  namestring
  Filterable
  
  Name of this entity
  
  aliasIdstring
  
  ID of an alias
  
  format = "uuid"
  
  scheduleobject
  
  Configuration to schedule a batch prediction
  
  Show schedule properties
  
  timezonestring
  Required
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job is scheduled to finish
  
  startDateTimestring
  Required
  
  When the job is scheduled to start
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  writebackobject
  
  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
  
  formatstring
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  
  default = "parquet"
  
  dstNamestring
  Required
  
  spaceIdstring
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapNamestring
  
  dstSourceNamestring
  
  dstCoordShapNamestring
  
  dstNotPredictedNamestring
  
  descriptionstring
  
  indexColumnstring
  
  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.
  
  deploymentIdstring
  
  ID of a model deployment
  
  format = "uuid"

Responses

201

Created

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "batch-prediction"
  
  attributesobject
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  aliasIdstring
  
  ID of an alias
  
  format = "uuid"
  
  ownerIdstring
  Filterable
  
  ID of owner/user for this entity
  
  scheduleobject
  
  Batch prediction job schedule
  
  Show schedule properties
  
  statusstring
  
  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"
  
  timezonestring
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job finished
  
  chronosJobIdstring
  
  The ID of the chronos job
  
  startDateTimestring
  
  When the job is scheduled to start
  
  failureAttemptsnumber
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  lastSuccessfulDateTimestring
  
  When the last successful job happened
  
  createdAtstring
  
  Timestamp when this was created
  
  createdBystring
  
  ID of the owner/user that ran this prediction batch
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  datasetIdstring
  
  ID of the dataset with the prediction results
  
  updatedAtstring
  
  Timestamp when this was updated
  
  writebackobject
  
  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
  
  formatstring
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  
  default = "parquet"
  
  dstNamestring
  Required
  
  spaceIdstring
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapNamestring
  
  dstSourceNamestring
  
  dstCoordShapNamestring
  
  dstNotPredictedNamestring
  
  indexColumnstring
  
  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.
  
  deploymentIdstring
  
  ID of a model deployment
  
  format = "uuid"
  
  errorMessagestring
  
  JSON string of error object
  
  outputDatasetstring
  
  Where to output dataset

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.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: '2025-12-31T23:59:00',
          recurrence: [
            'RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=16;BYMINUTE=30;BYSECOND=0',
          ],
          startDateTime: '2025-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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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":"2025-12-31T23:59:00","startDateTime":"2025-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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "batch-prediction"
  
  attributesobject
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  aliasIdstring
  
  ID of an alias
  
  format = "uuid"
  
  ownerIdstring
  Filterable
  
  ID of owner/user for this entity
  
  scheduleobject
  
  Batch prediction job schedule
  
  Show schedule properties
  
  statusstring
  
  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"
  
  timezonestring
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job finished
  
  chronosJobIdstring
  
  The ID of the chronos job
  
  startDateTimestring
  
  When the job is scheduled to start
  
  failureAttemptsnumber
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  lastSuccessfulDateTimestring
  
  When the last successful job happened
  
  createdAtstring
  
  Timestamp when this was created
  
  createdBystring
  
  ID of the owner/user that ran this prediction batch
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  datasetIdstring
  
  ID of the dataset with the prediction results
  
  updatedAtstring
  
  Timestamp when this was updated
  
  writebackobject
  
  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
  
  formatstring
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  
  default = "parquet"
  
  dstNamestring
  Required
  
  spaceIdstring
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapNamestring
  
  dstSourceNamestring
  
  dstCoordShapNamestring
  
  dstNotPredictedNamestring
  
  indexColumnstring
  
  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.
  
  deploymentIdstring
  
  ID of a model deployment
  
  format = "uuid"
  
  errorMessagestring
  
  JSON string of error object
  
  outputDatasetstring
  
  Where to output dataset

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Request Body

application/jsonarray 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
- opstring
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- pathstring
  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"
- valueany
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Responses

202

Accepted

application/jsonobject

Response for batch prediction predict action that indicates job and status
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "job"
  
  attributesobject
  Required
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Required
  
  corrIdstring
  Required
  
  The ID of a correlated resource of corrType
  
  statusstring
  Required
  
  Status of this job
  
  Can be one of: "pending""completed""cancelled""error"
  
  detailsobject
  Required
  
  Show details properties
  
  isScheduledboolean
  Required
  
  outputFilesarray of objects
  Required
  
  Show outputFiles properties
  
  keystring
  Required
  
  pathstring
  Required
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  fileNamestring
  Required
  
  fileTypestring
  Required
  
  Dataset file type
  
  lineageSchemaUpdatedboolean
  Required
  
  jobTypestring
  Required
  
  The type for this job
  
  Can be one of: "prediction"
  
  modelIdstring
  RequiredFilterable
  
  ID of the model
  
  format = "uuid"
  
  successboolean
  Required
  
  triggerstring
  Required
  
  corrTypestring
  Required
  
  Types names of correlated resources (batch 'prediction' and experiment_version)
  
  Can be one of: "batch-prediction""experiment-version"
  
  tenantIdstring
  RequiredFilterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  Required
  
  ID of the owner/user that created this entity
  
  deletedAtstring
  Required
  
  Timestamp when this is deleted
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  parentNamestring
  Required
  
  parentJobIdstring
  Required
  
  ID of the current job's parent
  
  deploymentIdstring
  Required
  
  ID of a model deployment
  
  format = "uuid"
  
  rowsPredictednumber
  Required
  
  experimentVersionNumberstring
  Required

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "batch-prediction-schedule"
  
  attributesobject
  Required
  
  Batch prediction job schedule
  
  Show attributes properties
  
  statusstring
  
  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"
  
  timezonestring
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job finished
  
  chronosJobIdstring
  
  The ID of the chronos job
  
  startDateTimestring
  
  When the job is scheduled to start
  
  failureAttemptsnumber
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  lastSuccessfulDateTimestring
  
  When the last successful job happened

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Request Body

application/jsonarray 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
- opstring
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- pathstring
  Required
  
  Path for the property you want to update
  
  Can be one of: "/startDateTime""/endDateTime""/timezone""/recurrence""/applyDatasetChangeOnly"
- valueany
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Request Body

application/jsonobject

Input values for a batch prediction schedule
Show application/json properties
- dataobject
  
  Show data properties
  
  typestring
  
  Can be one of: "batch-prediction-schedule"
  
  default = "batch-prediction-schedule"
  
  attributesobject
  
  Configuration to schedule a batch prediction
  
  Show attributes properties
  
  timezonestring
  Required
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job is scheduled to finish
  
  startDateTimestring
  Required
  
  When the job is scheduled to start
  
  applyDatasetChangeOnlyboolean
  
  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/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "batch-prediction-schedule"
  
  attributesobject
  Required
  
  Batch prediction job schedule
  
  Show attributes properties
  
  statusstring
  
  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"
  
  timezonestring
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job finished
  
  chronosJobIdstring
  
  The ID of the chronos job
  
  startDateTimestring
  
  When the job is scheduled to start
  
  failureAttemptsnumber
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  lastSuccessfulDateTimestring
  
  When the last successful job happened

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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":"2025-12-31T23:59:00","startDateTime":"2025-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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Request Body

application/jsonobject

Input values for adding deployed models to a deployment
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  typestring
  Required
  
  Can be one of: "deployed-models"
  
  default = "deployed-models"
  
  attributesobject
  Required
  
  Show attributes properties
  
  deployedModelIdsarray of strings
  Required
  
  IDs of all models deployed to the deployment

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Request Body

application/jsonobject

Input values for adding deployed models to a deployment
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  typestring
  Required
  
  Can be one of: "deployed-models"
  
  default = "deployed-models"
  
  attributesobject
  Required
  
  Show attributes properties
  
  deployedModelIdsarray of strings
  Required
  
  IDs of all models deployed to the deployment

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Query Parameters

includeNotPredictedReasonboolean

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

If true, shapley values included in response
includeSourceboolean

If true, source data included in response
indexstring

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

deploymentIdstring
Required

ID of the deployment

Request Body

application/jsonobject

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

Responses

200

Stream of combined prediction output returned successfully.

application/jsonobject

Input values for creating realtime predictions
Show application/json properties
- dataobject
  
  Show data properties
  
  typestring
  
  Can be one of: "realtime-prediction"
  
  default = "realtime-prediction"
  
  attributesobject
  
  Show attributes properties
  
  rowsarray of arrays
  
  Rows of the dataset from which to produce predictions
  
  schemaarray of objects
  
  List of features in the dataset
  
  Show schema properties
  
  namestring
  
  The name of a feature in the dataset

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

409

Conflict

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Query Parameters

filterstring
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
sortstring

Field(s) by which to sort response

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

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offsetinteger

Number of rows to skip before getting page[size]

Responses

200

OK

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "experiment"
  
  attributesobject
  Required
  
  An AutoML experiment
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  tenantIdstring
  RequiredFilterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  descriptionstring
  
  Description of this entity
- metaobject
  
  Meta for FIND operations
  
  Show meta properties
  
  countinteger
  Required
- linksobject
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  lastobject
  Required
  
  Show last properties
  
  hrefstring
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  nextobject
  Required
  
  Show next properties
  
  hrefstring
  
  Link to the next set of responses
  
  format = "uri"
  
  prevobject
  Required
  
  Show prev properties
  
  hrefstring
  
  Link to the previous set of responses
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  
  Link to the current set of responses
  
  format = "uri"
  
  firstobject
  Required
  
  Show first properties
  
  hrefstring
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

GET /api/v1/ml/experiments

import { createQlikApi } from '@qlik/api'

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

await qlik.ml.getMlExperiments({})

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Request Body

application/jsonobject

Input for creating this entity
Show application/json properties
- dataobject
  
  Data container for ExperimentInput
  
  Show data properties
  
  typestring
  
  Can be one of: "experiment"
  
  default = "experiment"
  
  attributesobject
  
  Experiment input attributes
  
  Show attributes properties
  
  namestring
  RequiredFilterable
  
  Name of this entity
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  descriptionstring
  
  Description of this entity

Responses

201

Created

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "experiment"
  
  attributesobject
  Required
  
  An AutoML experiment
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  tenantIdstring
  RequiredFilterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  descriptionstring
  
  Description of this entity

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

POST /api/v1/ml/experiments

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "experiment"
  
  attributesobject
  Required
  
  An AutoML experiment
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  spaceIdstring
  RequiredFilterable
  
  Space ID for this entity (empty string for personal space)
  
  tenantIdstring
  RequiredFilterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  descriptionstring
  
  Description of this entity

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

await qlik.ml.getMlExperiment('string')

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment

Request Body

application/jsonarray 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
- opstring
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- pathstring
  Required
  
  Path for the property you want to update
  
  Can be one of: "/name""/description""/spaceId"
- valueany
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.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',
  },
])

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

await qlik.ml.deleteMlExperiment('string')

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment

Request Body

application/jsonobject

Criteria to determine which pool of models to provide recommendations from
Show application/json properties
- deployedboolean
  
  Whether to only consider models that are already deployed
- algorithmsarray 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"
- fullSamplingboolean
  
  Whether to only consider models with 100% sampling
- versionNumbersarray of integers
  
  The versionNumbers of the experiment versions to consider models from

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  typestring
  Required
  
  Can be one of: "model-recommendation"
  
  attributesobject
  Required
  
  Model recommendations
  
  Show attributes properties
  
  bestModelobject
  
  A model based on an algorithm within an experiment version.
  
  Show bestModel properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  hpoNumnumber
  
  Version number of the hyperparameter optimization
  
  seqNumnumber
  
  Model sequence number within the experiment version
  
  statusstring
  
  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"
  
  columnsarray of strings
  
  Dataset columns selected as features
  
  metricsobject
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binaryobject
  
  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
  
  f1number
  
  The harmonic mean of precision and recall for training data
  
  aucnumber
  
  Area under curve (training data)
  
  mccnumber
  
  Matthews correlation coefficient (training data)
  
  npvnumber
  
  Negative predictive value (training data)
  
  f1Testnumber
  
  The harmonic mean of precision and recall for test data
  
  recallnumber
  
  The true positive rate (training data)
  
  aucTestnumber
  
  Area under curve (test data)
  
  falloutnumber
  
  The false positive rate (training data)
  
  logLossnumber
  
  Measures accuracy in logistic regression (training data)
  
  mccTestnumber
  
  Matthews correlation coefficient (test data)
  
  npvTestnumber
  
  Negative predictive value (test data)
  
  accuracynumber
  
  Average measure of how often the model made correct predictions (training data)
  
  missRatenumber
  
  The false negative rate (training data)
  
  precisionnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  thresholdnumber
  
  Probability that a prediction is true (training data)
  
  recallTestnumber
  
  The true positive rate (test data)
  
  falloutTestnumber
  
  The false positive rate (test data)
  
  logLossTestnumber
  
  Measures accuracy in logistic regression (test data)
  
  specificitynumber
  
  The true negative rate (training data)
  
  accuracyTestnumber
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTestnumber
  
  The false negative rate (test data)
  
  trueNegativenumber
  
  Actual false values correctly predicted as false (training data)
  
  truePositivenumber
  
  Actual true values correctly predicted as true (training data)
  
  falseNegativenumber
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositivenumber
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTestnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTestnumber
  
  Probability that a prediction is true (test data)
  
  specificityTestnumber
  
  The true negative rate (test data)
  
  trueNegativeTestnumber
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTestnumber
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTestnumber
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTestnumber
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclassobject
  
  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
  
  f1Macronumber
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micronumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracynumber
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weightednumber
  
  Weighted F1 (training data)
  
  f1MacroTestnumber
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTestnumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTestnumber
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTestnumber
  
  Weighted F1 (test data)
  
  confusionMatrixstring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTeststring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regressionobject
  
  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
  
  r2number
  
  R squared (training data)
  
  maenumber
  
  Mean absolute error (training data)
  
  msenumber
  
  Mean squared error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  r2Testnumber
  
  R squared (test data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mseTestnumber
  
  Mean squared error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  timeseriesobject
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  maenumber
  
  Mean absolute error (training data)
  
  mapenumber
  
  Mean absolute percentage error (training data)
  
  masenumber
  
  Mean absolute scaled error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  mdapenumber
  
  Median absolute percentage error (training data)
  
  smapenumber
  
  Symmetric mean absolute percentage error (training data)
  
  wmapenumber
  
  Weighted mean absolute percentage error (training data)
  
  mnrmsenumber
  
  Mean root mean squared error (training data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mdnrmsenumber
  
  Median root mean squared error (training data)
  
  mapeTestnumber
  
  Mean absolute percentage error (test data)
  
  maseTestnumber
  
  Mean absolute scaled error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  mdapeTestnumber
  
  Median absolute percentage error (test data)
  
  smapeTestnumber
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTestnumber
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTestnumber
  
  Mean root mean squared error (test data)
  
  mdnrmseTestnumber
  
  Median root mean squared error (test data)
  
  predictionSpeednumber
  Required
  
  This represents model prediction speed in rows/second
  
  batchNumnumber
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrvstring
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithmstring
  Filterable
  
  The algorithm used by this model
  
  createdAtstring
  
  Timestamp when this was created
  
  updatedAtstring
  
  Timestamp when this was updated
  
  modelStatestring
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  descriptionstring
  
  Description of this entity
  
  anomalyRationumber
  
  errorMessagestring
  
  JSON string of error object
  
  samplingRationumber
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeaturesarray of strings
  
  droppedFeaturesarray of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  namestring
  
  Name of dropped feature in the dataset
  
  reasonstring
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionIdstring
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeaturesarray of strings
  
  binaryImbalanceSamplingobject
  
  Show binaryImbalanceSampling properties
  
  sampleClassstring
  
  sampleRationumber
  
  sampleDirectionstring
  
  Can be one of: "up""down"
  
  fastestModelobject
  
  A model based on an algorithm within an experiment version.
  
  Show fastestModel properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  hpoNumnumber
  
  Version number of the hyperparameter optimization
  
  seqNumnumber
  
  Model sequence number within the experiment version
  
  statusstring
  
  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"
  
  columnsarray of strings
  
  Dataset columns selected as features
  
  metricsobject
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binaryobject
  
  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
  
  f1number
  
  The harmonic mean of precision and recall for training data
  
  aucnumber
  
  Area under curve (training data)
  
  mccnumber
  
  Matthews correlation coefficient (training data)
  
  npvnumber
  
  Negative predictive value (training data)
  
  f1Testnumber
  
  The harmonic mean of precision and recall for test data
  
  recallnumber
  
  The true positive rate (training data)
  
  aucTestnumber
  
  Area under curve (test data)
  
  falloutnumber
  
  The false positive rate (training data)
  
  logLossnumber
  
  Measures accuracy in logistic regression (training data)
  
  mccTestnumber
  
  Matthews correlation coefficient (test data)
  
  npvTestnumber
  
  Negative predictive value (test data)
  
  accuracynumber
  
  Average measure of how often the model made correct predictions (training data)
  
  missRatenumber
  
  The false negative rate (training data)
  
  precisionnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  thresholdnumber
  
  Probability that a prediction is true (training data)
  
  recallTestnumber
  
  The true positive rate (test data)
  
  falloutTestnumber
  
  The false positive rate (test data)
  
  logLossTestnumber
  
  Measures accuracy in logistic regression (test data)
  
  specificitynumber
  
  The true negative rate (training data)
  
  accuracyTestnumber
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTestnumber
  
  The false negative rate (test data)
  
  trueNegativenumber
  
  Actual false values correctly predicted as false (training data)
  
  truePositivenumber
  
  Actual true values correctly predicted as true (training data)
  
  falseNegativenumber
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositivenumber
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTestnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTestnumber
  
  Probability that a prediction is true (test data)
  
  specificityTestnumber
  
  The true negative rate (test data)
  
  trueNegativeTestnumber
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTestnumber
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTestnumber
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTestnumber
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclassobject
  
  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
  
  f1Macronumber
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micronumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracynumber
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weightednumber
  
  Weighted F1 (training data)
  
  f1MacroTestnumber
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTestnumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTestnumber
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTestnumber
  
  Weighted F1 (test data)
  
  confusionMatrixstring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTeststring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regressionobject
  
  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
  
  r2number
  
  R squared (training data)
  
  maenumber
  
  Mean absolute error (training data)
  
  msenumber
  
  Mean squared error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  r2Testnumber
  
  R squared (test data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mseTestnumber
  
  Mean squared error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  timeseriesobject
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  maenumber
  
  Mean absolute error (training data)
  
  mapenumber
  
  Mean absolute percentage error (training data)
  
  masenumber
  
  Mean absolute scaled error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  mdapenumber
  
  Median absolute percentage error (training data)
  
  smapenumber
  
  Symmetric mean absolute percentage error (training data)
  
  wmapenumber
  
  Weighted mean absolute percentage error (training data)
  
  mnrmsenumber
  
  Mean root mean squared error (training data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mdnrmsenumber
  
  Median root mean squared error (training data)
  
  mapeTestnumber
  
  Mean absolute percentage error (test data)
  
  maseTestnumber
  
  Mean absolute scaled error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  mdapeTestnumber
  
  Median absolute percentage error (test data)
  
  smapeTestnumber
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTestnumber
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTestnumber
  
  Mean root mean squared error (test data)
  
  mdnrmseTestnumber
  
  Median root mean squared error (test data)
  
  predictionSpeednumber
  Required
  
  This represents model prediction speed in rows/second
  
  batchNumnumber
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrvstring
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithmstring
  Filterable
  
  The algorithm used by this model
  
  createdAtstring
  
  Timestamp when this was created
  
  updatedAtstring
  
  Timestamp when this was updated
  
  modelStatestring
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  descriptionstring
  
  Description of this entity
  
  anomalyRationumber
  
  errorMessagestring
  
  JSON string of error object
  
  samplingRationumber
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeaturesarray of strings
  
  droppedFeaturesarray of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  namestring
  
  Name of dropped feature in the dataset
  
  reasonstring
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionIdstring
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeaturesarray of strings
  
  binaryImbalanceSamplingobject
  
  Show binaryImbalanceSampling properties
  
  sampleClassstring
  
  sampleRationumber
  
  sampleDirectionstring
  
  Can be one of: "up""down"
  
  mostAccurateModelobject
  
  A model based on an algorithm within an experiment version.
  
  Show mostAccurateModel properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  hpoNumnumber
  
  Version number of the hyperparameter optimization
  
  seqNumnumber
  
  Model sequence number within the experiment version
  
  statusstring
  
  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"
  
  columnsarray of strings
  
  Dataset columns selected as features
  
  metricsobject
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binaryobject
  
  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
  
  f1number
  
  The harmonic mean of precision and recall for training data
  
  aucnumber
  
  Area under curve (training data)
  
  mccnumber
  
  Matthews correlation coefficient (training data)
  
  npvnumber
  
  Negative predictive value (training data)
  
  f1Testnumber
  
  The harmonic mean of precision and recall for test data
  
  recallnumber
  
  The true positive rate (training data)
  
  aucTestnumber
  
  Area under curve (test data)
  
  falloutnumber
  
  The false positive rate (training data)
  
  logLossnumber
  
  Measures accuracy in logistic regression (training data)
  
  mccTestnumber
  
  Matthews correlation coefficient (test data)
  
  npvTestnumber
  
  Negative predictive value (test data)
  
  accuracynumber
  
  Average measure of how often the model made correct predictions (training data)
  
  missRatenumber
  
  The false negative rate (training data)
  
  precisionnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  thresholdnumber
  
  Probability that a prediction is true (training data)
  
  recallTestnumber
  
  The true positive rate (test data)
  
  falloutTestnumber
  
  The false positive rate (test data)
  
  logLossTestnumber
  
  Measures accuracy in logistic regression (test data)
  
  specificitynumber
  
  The true negative rate (training data)
  
  accuracyTestnumber
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTestnumber
  
  The false negative rate (test data)
  
  trueNegativenumber
  
  Actual false values correctly predicted as false (training data)
  
  truePositivenumber
  
  Actual true values correctly predicted as true (training data)
  
  falseNegativenumber
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositivenumber
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTestnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTestnumber
  
  Probability that a prediction is true (test data)
  
  specificityTestnumber
  
  The true negative rate (test data)
  
  trueNegativeTestnumber
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTestnumber
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTestnumber
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTestnumber
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclassobject
  
  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
  
  f1Macronumber
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micronumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracynumber
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weightednumber
  
  Weighted F1 (training data)
  
  f1MacroTestnumber
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTestnumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTestnumber
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTestnumber
  
  Weighted F1 (test data)
  
  confusionMatrixstring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTeststring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regressionobject
  
  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
  
  r2number
  
  R squared (training data)
  
  maenumber
  
  Mean absolute error (training data)
  
  msenumber
  
  Mean squared error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  r2Testnumber
  
  R squared (test data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mseTestnumber
  
  Mean squared error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  timeseriesobject
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  maenumber
  
  Mean absolute error (training data)
  
  mapenumber
  
  Mean absolute percentage error (training data)
  
  masenumber
  
  Mean absolute scaled error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  mdapenumber
  
  Median absolute percentage error (training data)
  
  smapenumber
  
  Symmetric mean absolute percentage error (training data)
  
  wmapenumber
  
  Weighted mean absolute percentage error (training data)
  
  mnrmsenumber
  
  Mean root mean squared error (training data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mdnrmsenumber
  
  Median root mean squared error (training data)
  
  mapeTestnumber
  
  Mean absolute percentage error (test data)
  
  maseTestnumber
  
  Mean absolute scaled error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  mdapeTestnumber
  
  Median absolute percentage error (test data)
  
  smapeTestnumber
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTestnumber
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTestnumber
  
  Mean root mean squared error (test data)
  
  mdnrmseTestnumber
  
  Median root mean squared error (test data)
  
  predictionSpeednumber
  Required
  
  This represents model prediction speed in rows/second
  
  batchNumnumber
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrvstring
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithmstring
  Filterable
  
  The algorithm used by this model
  
  createdAtstring
  
  Timestamp when this was created
  
  updatedAtstring
  
  Timestamp when this was updated
  
  modelStatestring
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  descriptionstring
  
  Description of this entity
  
  anomalyRationumber
  
  errorMessagestring
  
  JSON string of error object
  
  samplingRationumber
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeaturesarray of strings
  
  droppedFeaturesarray of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  namestring
  
  Name of dropped feature in the dataset
  
  reasonstring
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionIdstring
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeaturesarray of strings
  
  binaryImbalanceSamplingobject
  
  Show binaryImbalanceSampling properties
  
  sampleClassstring
  
  sampleRationumber
  
  sampleDirectionstring
  
  Can be one of: "up""down"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Query Parameters

filterstring
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
sortstring

Field(s) by which to sort response

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

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offsetinteger

Number of rows to skip before getting page[size]

Path Parameters

experimentIdstring
Required

ID of the experiment

Responses

200

OK

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "model"
  
  attributesobject
  Required
  
  A model based on an algorithm within an experiment version.
  
  Show attributes properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  hpoNumnumber
  
  Version number of the hyperparameter optimization
  
  seqNumnumber
  
  Model sequence number within the experiment version
  
  statusstring
  
  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"
  
  columnsarray of strings
  
  Dataset columns selected as features
  
  metricsobject
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binaryobject
  
  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
  
  f1number
  
  The harmonic mean of precision and recall for training data
  
  aucnumber
  
  Area under curve (training data)
  
  mccnumber
  
  Matthews correlation coefficient (training data)
  
  npvnumber
  
  Negative predictive value (training data)
  
  f1Testnumber
  
  The harmonic mean of precision and recall for test data
  
  recallnumber
  
  The true positive rate (training data)
  
  aucTestnumber
  
  Area under curve (test data)
  
  falloutnumber
  
  The false positive rate (training data)
  
  logLossnumber
  
  Measures accuracy in logistic regression (training data)
  
  mccTestnumber
  
  Matthews correlation coefficient (test data)
  
  npvTestnumber
  
  Negative predictive value (test data)
  
  accuracynumber
  
  Average measure of how often the model made correct predictions (training data)
  
  missRatenumber
  
  The false negative rate (training data)
  
  precisionnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  thresholdnumber
  
  Probability that a prediction is true (training data)
  
  recallTestnumber
  
  The true positive rate (test data)
  
  falloutTestnumber
  
  The false positive rate (test data)
  
  logLossTestnumber
  
  Measures accuracy in logistic regression (test data)
  
  specificitynumber
  
  The true negative rate (training data)
  
  accuracyTestnumber
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTestnumber
  
  The false negative rate (test data)
  
  trueNegativenumber
  
  Actual false values correctly predicted as false (training data)
  
  truePositivenumber
  
  Actual true values correctly predicted as true (training data)
  
  falseNegativenumber
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositivenumber
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTestnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTestnumber
  
  Probability that a prediction is true (test data)
  
  specificityTestnumber
  
  The true negative rate (test data)
  
  trueNegativeTestnumber
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTestnumber
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTestnumber
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTestnumber
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclassobject
  
  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
  
  f1Macronumber
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micronumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracynumber
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weightednumber
  
  Weighted F1 (training data)
  
  f1MacroTestnumber
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTestnumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTestnumber
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTestnumber
  
  Weighted F1 (test data)
  
  confusionMatrixstring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTeststring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regressionobject
  
  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
  
  r2number
  
  R squared (training data)
  
  maenumber
  
  Mean absolute error (training data)
  
  msenumber
  
  Mean squared error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  r2Testnumber
  
  R squared (test data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mseTestnumber
  
  Mean squared error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  timeseriesobject
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  maenumber
  
  Mean absolute error (training data)
  
  mapenumber
  
  Mean absolute percentage error (training data)
  
  masenumber
  
  Mean absolute scaled error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  mdapenumber
  
  Median absolute percentage error (training data)
  
  smapenumber
  
  Symmetric mean absolute percentage error (training data)
  
  wmapenumber
  
  Weighted mean absolute percentage error (training data)
  
  mnrmsenumber
  
  Mean root mean squared error (training data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mdnrmsenumber
  
  Median root mean squared error (training data)
  
  mapeTestnumber
  
  Mean absolute percentage error (test data)
  
  maseTestnumber
  
  Mean absolute scaled error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  mdapeTestnumber
  
  Median absolute percentage error (test data)
  
  smapeTestnumber
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTestnumber
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTestnumber
  
  Mean root mean squared error (test data)
  
  mdnrmseTestnumber
  
  Median root mean squared error (test data)
  
  batchNumnumber
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrvstring
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithmstring
  Filterable
  
  The algorithm used by this model
  
  createdAtstring
  
  Timestamp when this was created
  
  updatedAtstring
  
  Timestamp when this was updated
  
  modelStatestring
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  descriptionstring
  
  Description of this entity
  
  anomalyRationumber
  
  errorMessagestring
  
  JSON string of error object
  
  samplingRationumber
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeaturesarray of strings
  
  droppedFeaturesarray of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  namestring
  
  Name of dropped feature in the dataset
  
  reasonstring
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionIdstring
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeaturesarray of strings
  
  binaryImbalanceSamplingobject
  
  Show binaryImbalanceSampling properties
  
  sampleClassstring
  
  sampleRationumber
  
  sampleDirectionstring
  
  Can be one of: "up""down"
- metaobject
  
  Meta for FIND operations
  
  Show meta properties
  
  countinteger
  Required
- linksobject
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  lastobject
  Required
  
  Show last properties
  
  hrefstring
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  nextobject
  Required
  
  Show next properties
  
  hrefstring
  
  Link to the next set of responses
  
  format = "uri"
  
  prevobject
  Required
  
  Show prev properties
  
  hrefstring
  
  Link to the previous set of responses
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  
  Link to the current set of responses
  
  format = "uri"
  
  firstobject
  Required
  
  Show first properties
  
  hrefstring
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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
          }
        },
        "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)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment
modelIdstring
Required

ID of the model

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "model"
  
  attributesobject
  Required
  
  A model based on an algorithm within an experiment version.
  
  Show attributes properties
  
  idstring
  Filterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  hpoNumnumber
  
  Version number of the hyperparameter optimization
  
  seqNumnumber
  
  Model sequence number within the experiment version
  
  statusstring
  
  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"
  
  columnsarray of strings
  
  Dataset columns selected as features
  
  metricsobject
  
  Model metrics based on the type of model
  
  Show metrics properties
  
  binaryobject
  
  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
  
  f1number
  
  The harmonic mean of precision and recall for training data
  
  aucnumber
  
  Area under curve (training data)
  
  mccnumber
  
  Matthews correlation coefficient (training data)
  
  npvnumber
  
  Negative predictive value (training data)
  
  f1Testnumber
  
  The harmonic mean of precision and recall for test data
  
  recallnumber
  
  The true positive rate (training data)
  
  aucTestnumber
  
  Area under curve (test data)
  
  falloutnumber
  
  The false positive rate (training data)
  
  logLossnumber
  
  Measures accuracy in logistic regression (training data)
  
  mccTestnumber
  
  Matthews correlation coefficient (test data)
  
  npvTestnumber
  
  Negative predictive value (test data)
  
  accuracynumber
  
  Average measure of how often the model made correct predictions (training data)
  
  missRatenumber
  
  The false negative rate (training data)
  
  precisionnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (training data)
  
  thresholdnumber
  
  Probability that a prediction is true (training data)
  
  recallTestnumber
  
  The true positive rate (test data)
  
  falloutTestnumber
  
  The false positive rate (test data)
  
  logLossTestnumber
  
  Measures accuracy in logistic regression (test data)
  
  specificitynumber
  
  The true negative rate (training data)
  
  accuracyTestnumber
  
  Average measure of how often the model made correct predictions (test data)
  
  missRateTestnumber
  
  The false negative rate (test data)
  
  trueNegativenumber
  
  Actual false values correctly predicted as false (training data)
  
  truePositivenumber
  
  Actual true values correctly predicted as true (training data)
  
  falseNegativenumber
  
  Actual true values incorrectly predicted as false (training data)
  
  falsePositivenumber
  
  Actual false values incorrectly predicted as true (training data)
  
  precisionTestnumber
  
  Positive predictive value. Probability that the model was correct when it predicted something was true. (test data)
  
  thresholdTestnumber
  
  Probability that a prediction is true (test data)
  
  specificityTestnumber
  
  The true negative rate (test data)
  
  trueNegativeTestnumber
  
  Actual false values correctly predicted as false (test data)
  
  truePositiveTestnumber
  
  Actual true values correctly predicted as true (test data)
  
  falseNegativeTestnumber
  
  Actual true values incorrectly predicted as false (test data)
  
  falsePositiveTestnumber
  
  Actual false values incorrectly predicted as true (test data)
  
  multiclassobject
  
  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
  
  f1Macronumber
  
  Macro F1 is the averaged F1 value for each class without weighting (training data)
  
  f1Micronumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (training data)
  
  accuracynumber
  
  Average of how often the model made a correct prediction (training data)
  
  f1Weightednumber
  
  Weighted F1 (training data)
  
  f1MacroTestnumber
  
  Macro F1 is the averaged F1 value for each class without weighting (test data)
  
  f1MicroTestnumber
  
  Micro F1 is the F1 value calculated across the entire confusion matrix (test data)
  
  accuracyTestnumber
  
  Average of how often the model made a correct prediction (test data)
  
  f1WeightedTestnumber
  
  Weighted F1 (test data)
  
  confusionMatrixstring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  confusionMatrixTeststring
  
  A matrix summary of the accuracy of predictions in a classification model (training data)
  
  regressionobject
  
  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
  
  r2number
  
  R squared (training data)
  
  maenumber
  
  Mean absolute error (training data)
  
  msenumber
  
  Mean squared error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  r2Testnumber
  
  R squared (test data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mseTestnumber
  
  Mean squared error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  timeseriesobject
  
  Timeseries metrics experiments valid for timeseries forecasting.
  
  Show timeseries properties
  
  maenumber
  
  Mean absolute error (training data)
  
  mapenumber
  
  Mean absolute percentage error (training data)
  
  masenumber
  
  Mean absolute scaled error (training data)
  
  rmsenumber
  
  Root mean squared error (training data)
  
  mdapenumber
  
  Median absolute percentage error (training data)
  
  smapenumber
  
  Symmetric mean absolute percentage error (training data)
  
  wmapenumber
  
  Weighted mean absolute percentage error (training data)
  
  mnrmsenumber
  
  Mean root mean squared error (training data)
  
  maeTestnumber
  
  Mean absolute error (test data)
  
  mdnrmsenumber
  
  Median root mean squared error (training data)
  
  mapeTestnumber
  
  Mean absolute percentage error (test data)
  
  maseTestnumber
  
  Mean absolute scaled error (test data)
  
  rmseTestnumber
  
  Root mean squared error (test data)
  
  mdapeTestnumber
  
  Median absolute percentage error (test data)
  
  smapeTestnumber
  
  Symmetric mean absolute percentage error (test data)
  
  wmapeTestnumber
  
  Weighted mean absolute percentage error (test data)
  
  mnrmseTestnumber
  
  Mean root mean squared error (test data)
  
  mdnrmseTestnumber
  
  Median root mean squared error (test data)
  
  batchNumnumber
  Filterable
  
  Batch number indicates the index of the experiment version fold (most relevant when HPO is enabled)
  
  algoAbbrvstring
  
  Model algorithm name abbreviation
  
  Can be one of: "CATBC""CATBR""ELNC""GNBC""LGBMC""LGBMR""LINR""LOGC""LSOC""RAFC""RAFR""SGDR""XGBC""XGBR"
  
  algorithmstring
  Filterable
  
  The algorithm used by this model
  
  createdAtstring
  
  Timestamp when this was created
  
  updatedAtstring
  
  Timestamp when this was updated
  
  modelStatestring
  Filterable
  
  Model state. These are the state of the model in relation to deployments.
  
  Can be one of: "pending""enabled""disabled""inactive"
  
  descriptionstring
  
  Description of this entity
  
  anomalyRationumber
  
  errorMessagestring
  
  JSON string of error object
  
  samplingRationumber
  Filterable
  
  Ratio of sample data in relation to the dataset
  
  binningFeaturesarray of strings
  
  droppedFeaturesarray of objects
  
  Features dropped because they're unsuitable
  
  Show droppedFeatures properties
  
  namestring
  
  Name of dropped feature in the dataset
  
  reasonstring
  
  Reason the feature was dropped
  
  Can be one of: "highly_correlated""has_target_leakage""is_date_engineered""feature_with_low_importance"
  
  experimentVersionIdstring
  Filterable
  
  ID of the experiment version
  
  format = "uuid"
  
  powerTransformFeaturesarray of strings
  
  binaryImbalanceSamplingobject
  
  Show binaryImbalanceSampling properties
  
  sampleClassstring
  
  sampleRationumber
  
  sampleDirectionstring
  
  Can be one of: "up""down"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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
        }
      },
      "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)
Categories

Query Parameters

filterstring
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
sortstring

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"
limitinteger

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offsetinteger

Number of rows to skip before getting page[size]

Path Parameters

experimentIdstring
Required

ID of the experiment

Responses

200

OK

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "experiment-version"
  
  attributesobject
  Required
  
  An AutoML experiment version. This is a configuration for training models within an experiment.
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  RequiredFilterable
  
  Current status of this entity
  
  Can be one of: "ready""error""cancelled""pending""dataprep_requested""datasync_requested""datasync_done"
  
  default = "pending"
  
  targetstring
  Required
  
  The target field in the dataset
  
  pipelineobject
  
  Pipeline metadata including transformations to apply to columns and specific schema configuration data
  
  Show pipeline properties
  
  transformsarray of objects
  
  Show transforms properties
  
  columnobject
  
  Show column properties
  
  namestring
  Required
  
  changeTypestring
  Required
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  dataSetIdstring
  Required
  
  The Qlik catalog dataset ID
  
  profileIdstring
  
  ID of the dataset profile with metadata about source data
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  algorithmsarray 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"
  
  topModelIdstring
  
  ID of the top model (based on training scores) in this experiment version
  
  dateIndexesarray of strings
  
  A optional date column name to index
  
  minItems = 0, maxItems = 1
  
  errorMessagestring
  
  JSON string of error object
  
  experimentIdstring
  Required
  
  ID of the experiment
  
  format = "uuid"
  
  featuresListarray 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
  
  namestring
  
  Name of the feature column
  
  includeboolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataTypestring
  
  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"
  
  changeTypestring
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureTypestring
  
  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"
  
  parentFeaturestring
  
  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.
  
  lastBatchNuminteger
  
  Number of the last batch
  
  datasetOriginstring
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  
  default = "new"
  
  versionNumberinteger
  
  -based sequential version number within the experiment
  
  experimentModestring
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  
  default = "intelligent"
  
  experimentTypestring
  Required
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"
  
  createdByUserIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  trainingDurationinteger
  
  Optional training duration in seconds. If not provided, max value used. If provided, min 900 (15m) and max 21600 (6h).
  
  minimum = 900, maximum = 21600
  
  preprocessedInsightsarray of objects
  
  Preprocessed insights. Like feature insights but with fewer details.
  
  Show preprocessedInsights properties
  
  namestring
  Required
  
  Name of the preprocessed insight column
  
  insightsarray 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"
  
  willBeDroppedboolean
  Required
  
  Whether this feature insight will be dropped due to free text or high cardinality that makes it less useful
- metaobject
  
  Meta for FIND operations
  
  Show meta properties
  
  countinteger
  Required
- linksobject
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  lastobject
  Required
  
  Show last properties
  
  hrefstring
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  nextobject
  Required
  
  Show next properties
  
  hrefstring
  
  Link to the next set of responses
  
  format = "uri"
  
  prevobject
  Required
  
  Show prev properties
  
  hrefstring
  
  Link to the previous set of responses
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  
  Link to the current set of responses
  
  format = "uri"
  
  firstobject
  Required
  
  Show first properties
  
  hrefstring
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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,
        "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)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment

Request Body

application/jsonobject

Input for creating a new experiment version. Defaults provided in the ProfileInsights response.
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  typestring
  Required
  
  Can be one of: "experiment-version"
  
  default = "experiment-version"
  
  attributesobject
  Required
  
  Show attributes properties
  
  namestring
  Required
  
  default = "Experiment version name. Defaults to current date."
  
  targetstring
  Required
  
  The target field in the dataset. Set in first experiment version and can't be changed in subsequent versions.
  
  pipelineobject
  
  Pipeline metadata including transformations to apply to columns and specific schema configuration data
  
  Show pipeline properties
  
  transformsarray of objects
  
  Show transforms properties
  
  columnobject
  
  Show column properties
  
  namestring
  Required
  
  changeTypestring
  Required
  
  dataSetIdstring
  Required
  
  The Qlik catalog dataset ID
  
  algorithmsarray 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"
  
  dateIndexesarray of strings
  
  A optional date column name to index
  
  minItems = 0, maxItems = 1
  
  featuresListarray 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
  
  namestring
  
  Name of the feature column
  
  includeboolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataTypestring
  
  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"
  
  changeTypestring
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureTypestring
  
  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"
  
  parentFeaturestring
  
  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.
  
  datasetOriginstring
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  
  default = "new"
  
  experimentModestring
  Required
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  
  default = "intelligent"
  
  experimentTypestring
  Required
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"
  
  trainingDurationinteger
  
  Optional training duration in seconds. If not provided, max value used. If provided, min 900 (15m) and max 21600 (6h).
  
  minimum = 900, maximum = 21600

Responses

201

Accepted

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "experiment-version"
  
  attributesobject
  Required
  
  An AutoML experiment version. This is a configuration for training models within an experiment.
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  RequiredFilterable
  
  Current status of this entity
  
  Can be one of: "ready""error""cancelled""pending""dataprep_requested""datasync_requested""datasync_done"
  
  default = "pending"
  
  targetstring
  Required
  
  The target field in the dataset
  
  pipelineobject
  
  Pipeline metadata including transformations to apply to columns and specific schema configuration data
  
  Show pipeline properties
  
  transformsarray of objects
  
  Show transforms properties
  
  columnobject
  
  Show column properties
  
  namestring
  Required
  
  changeTypestring
  Required
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  dataSetIdstring
  Required
  
  The Qlik catalog dataset ID
  
  profileIdstring
  
  ID of the dataset profile with metadata about source data
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  algorithmsarray 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"
  
  topModelIdstring
  
  ID of the top model (based on training scores) in this experiment version
  
  dateIndexesarray of strings
  
  A optional date column name to index
  
  minItems = 0, maxItems = 1
  
  errorMessagestring
  
  JSON string of error object
  
  experimentIdstring
  Required
  
  ID of the experiment
  
  format = "uuid"
  
  featuresListarray 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
  
  namestring
  
  Name of the feature column
  
  includeboolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataTypestring
  
  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"
  
  changeTypestring
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureTypestring
  
  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"
  
  parentFeaturestring
  
  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.
  
  lastBatchNuminteger
  
  Number of the last batch
  
  datasetOriginstring
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  
  default = "new"
  
  versionNumberinteger
  
  -based sequential version number within the experiment
  
  experimentModestring
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  
  default = "intelligent"
  
  experimentTypestring
  Required
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"
  
  createdByUserIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  trainingDurationinteger
  
  Optional training duration in seconds. If not provided, max value used. If provided, min 900 (15m) and max 21600 (6h).
  
  minimum = 900, maximum = 21600
  
  preprocessedInsightsarray of objects
  
  Preprocessed insights. Like feature insights but with fewer details.
  
  Show preprocessedInsights properties
  
  namestring
  Required
  
  Name of the preprocessed insight column
  
  insightsarray 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"
  
  willBeDroppedboolean
  Required
  
  Whether this feature insight will be dropped due to free text or high cardinality that makes it less useful

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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}}}'

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,
      "preprocessedInsights": [
        {
          "name": "string",
          "insights": [],
          "willBeDropped": true
        }
      ]
    }
  }
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment
experimentVersionIdstring
Required

ID of the experiment version

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "experiment-version"
  
  attributesobject
  Required
  
  An AutoML experiment version. This is a configuration for training models within an experiment.
  
  Show attributes properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Filterable
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  RequiredFilterable
  
  Current status of this entity
  
  Can be one of: "ready""error""cancelled""pending""dataprep_requested""datasync_requested""datasync_done"
  
  default = "pending"
  
  targetstring
  Required
  
  The target field in the dataset
  
  pipelineobject
  
  Pipeline metadata including transformations to apply to columns and specific schema configuration data
  
  Show pipeline properties
  
  transformsarray of objects
  
  Show transforms properties
  
  columnobject
  
  Show column properties
  
  namestring
  Required
  
  changeTypestring
  Required
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  dataSetIdstring
  Required
  
  The Qlik catalog dataset ID
  
  profileIdstring
  
  ID of the dataset profile with metadata about source data
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  algorithmsarray 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"
  
  topModelIdstring
  
  ID of the top model (based on training scores) in this experiment version
  
  dateIndexesarray of strings
  
  A optional date column name to index
  
  minItems = 0, maxItems = 1
  
  errorMessagestring
  
  JSON string of error object
  
  experimentIdstring
  Required
  
  ID of the experiment
  
  format = "uuid"
  
  featuresListarray 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
  
  namestring
  
  Name of the feature column
  
  includeboolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataTypestring
  
  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"
  
  changeTypestring
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureTypestring
  
  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"
  
  parentFeaturestring
  
  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.
  
  lastBatchNuminteger
  
  Number of the last batch
  
  datasetOriginstring
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  
  default = "new"
  
  versionNumberinteger
  
  -based sequential version number within the experiment
  
  experimentModestring
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  
  default = "intelligent"
  
  experimentTypestring
  Required
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"
  
  createdByUserIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  trainingDurationinteger
  
  Optional training duration in seconds. If not provided, max value used. If provided, min 900 (15m) and max 21600 (6h).
  
  minimum = 900, maximum = 21600
  
  preprocessedInsightsarray of objects
  
  Preprocessed insights. Like feature insights but with fewer details.
  
  Show preprocessedInsights properties
  
  namestring
  Required
  
  Name of the preprocessed insight column
  
  insightsarray 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"
  
  willBeDroppedboolean
  Required
  
  Whether this feature insight will be dropped due to free text or high cardinality that makes it less useful

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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,
      "preprocessedInsights": [
        {
          "name": "string",
          "insights": [],
          "willBeDropped": true
        }
      ]
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment
experimentVersionIdstring
Required

ID of the experiment version

Request Body

application/jsonarray of objects

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

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

experimentIdstring
Required

ID of the experiment
experimentVersionIdstring
Required

ID of the experiment version

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Path Parameters

corrTypestring
Required

The type of a resource paired with a corrId

Can be one of: "batch-prediction""experiment-version"
corrIdstring
Required

The ID of a correlated resource of corrType

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

405

Method Not Allowed

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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)
Categories

Request Body

application/jsonobject

Input to get dataset and feature metadata needed to create experiment versions
Show application/json properties
- dataobject
  
  Data wrapper for request input
  
  Show data properties
  
  typestring
  
  Can be one of: "profile-insights"
  
  default = "profile-insights"
  
  attributesobject
  
  The request body for this resource
  
  Show attributes properties
  
  targetstring
  
  Optional selected target provided on subsequent requests
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  shouldWaitboolean
  
  Whether the server should or client should manage polling/waiting
  
  default = false
  
  experimentTypestring
  
  Experiment type
  
  Can be one of: "binary""multiclass""regression"

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "profile-insights"
  
  attributesobject
  Required
  
  Insights (metadata) about an experiment dataset
  
  Show attributes properties
  
  statusstring
  Required
  
  Status of profile insights. Not available until ready.
  
  Can be one of: "pending""error""ready"
  
  default = "pending"
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  insightsarray of objects
  
  List of feature insights object, one per feature in the dataset
  
  Show insights properties
  
  namestring
  Required
  
  Name of the feature insight
  
  insightsarray 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"
  
  willBeDroppedboolean
  Required
  
  Whether this feature will be dropped. Traits like high cardinality make some features less predictive or too costly to merit use.
  
  cannotBeTargetboolean
  Required
  
  Whether a feature cannot be the target field
  
  experimentTypesarray of strings
  Required
  
  Experiment types in this feature insight
  
  Values may be any of: "binary""multiclass""regression"
  
  defaultFeatureTypestring
  
  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"
  
  engineeredFeaturesarray 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.
  
  estimatedMaxForecastHorizoninteger
  
  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.
  
  tenantIdstring
  RequiredFilterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  algorithmsarray 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"
  
  defaultVersionConfigobject
  
  Show defaultVersionConfig properties
  
  namestring
  Required
  
  default = "Experiment version name. Defaults to current date/time."
  
  dataSetIdstring
  Required
  
  The Qlik catalog dataset ID
  
  featuresListarray 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
  
  namestring
  
  Name of the feature column
  
  includeboolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataTypestring
  
  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"
  
  changeTypestring
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureTypestring
  
  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"
  
  parentFeaturestring
  
  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.
  
  datasetOriginstring
  Required
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  
  default = "new"
  
  experimentModestring
  Required
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  
  default = "intelligent"

202

Accepted

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "profile-insights"
  
  attributesobject
  Required
  
  Insights (metadata) about an experiment dataset
  
  Show attributes properties
  
  statusstring
  Required
  
  Status of profile insights. Not available until ready.
  
  Can be one of: "pending""error""ready"
  
  default = "pending"
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  insightsarray of objects
  
  List of feature insights object, one per feature in the dataset
  
  Show insights properties
  
  namestring
  Required
  
  Name of the feature insight
  
  insightsarray 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"
  
  willBeDroppedboolean
  Required
  
  Whether this feature will be dropped. Traits like high cardinality make some features less predictive or too costly to merit use.
  
  cannotBeTargetboolean
  Required
  
  Whether a feature cannot be the target field
  
  experimentTypesarray of strings
  Required
  
  Experiment types in this feature insight
  
  Values may be any of: "binary""multiclass""regression"
  
  defaultFeatureTypestring
  
  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"
  
  engineeredFeaturesarray 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.
  
  estimatedMaxForecastHorizoninteger
  
  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.
  
  tenantIdstring
  RequiredFilterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  algorithmsarray 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"
  
  defaultVersionConfigobject
  
  Show defaultVersionConfig properties
  
  namestring
  Required
  
  default = "Experiment version name. Defaults to current date/time."
  
  dataSetIdstring
  Required
  
  The Qlik catalog dataset ID
  
  featuresListarray 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
  
  namestring
  
  Name of the feature column
  
  includeboolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataTypestring
  
  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"
  
  changeTypestring
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureTypestring
  
  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"
  
  parentFeaturestring
  
  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.
  
  datasetOriginstring
  Required
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  
  default = "new"
  
  experimentModestring
  Required
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  
  default = "intelligent"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

POST /api/v1/ml/profile-insights

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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","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"
      ],
      "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)
Categories

Query Parameters

targetstring

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

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

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

Path Parameters

dataSetIdstring
Required

The Qlik catalog dataset ID

Responses

200

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  RequiredFilterable
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "profile-insights"
  
  attributesobject
  Required
  
  Insights (metadata) about an experiment dataset
  
  Show attributes properties
  
  statusstring
  Required
  
  Status of profile insights. Not available until ready.
  
  Can be one of: "pending""error""ready"
  
  default = "pending"
  
  ownerIdstring
  RequiredFilterable
  
  ID of owner/user for this entity
  
  insightsarray of objects
  
  List of feature insights object, one per feature in the dataset
  
  Show insights properties
  
  namestring
  Required
  
  Name of the feature insight
  
  insightsarray 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"
  
  willBeDroppedboolean
  Required
  
  Whether this feature will be dropped. Traits like high cardinality make some features less predictive or too costly to merit use.
  
  cannotBeTargetboolean
  Required
  
  Whether a feature cannot be the target field
  
  experimentTypesarray of strings
  Required
  
  Experiment types in this feature insight
  
  Values may be any of: "binary""multiclass""regression"
  
  defaultFeatureTypestring
  
  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"
  
  engineeredFeaturesarray 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.
  
  estimatedMaxForecastHorizoninteger
  
  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.
  
  tenantIdstring
  RequiredFilterable
  
  Tenant ID for this entity
  
  format = "uuid"
  
  algorithmsarray 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"
  
  defaultVersionConfigobject
  
  Show defaultVersionConfig properties
  
  namestring
  Required
  
  default = "Experiment version name. Defaults to current date/time."
  
  dataSetIdstring
  Required
  
  The Qlik catalog dataset ID
  
  featuresListarray 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
  
  namestring
  
  Name of the feature column
  
  includeboolean
  
  Include this feature in your experiment version? Default here is based on insights for this feature (e.g. willBeDropped).
  
  dataTypestring
  
  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"
  
  changeTypestring
  
  Indicates if you want to change the featureType for this feature within the experiment version
  
  Can be one of: "categorical""numeric""date""freetext"
  
  featureTypestring
  
  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"
  
  parentFeaturestring
  
  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.
  
  datasetOriginstring
  Required
  
  Whether this is a new or other dataset
  
  Can be one of: "new""changed""refreshed""same"
  
  default = "new"
  
  experimentModestring
  Required
  
  The model training mode for the experiment version
  
  Can be one of: "intelligent""manual""manual_hpo"
  
  default = "intelligent"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

404

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

500

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

502

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

default

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
- traceIdstring

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

import { createQlikApi } from '@qlik/api'

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

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

This API is not included yet in qlik-cli

curl "https://your-tenant.us.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"
      ],
      "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