Data qualities

API for triggering data quality computations and retrieving global results to assess the quality of your datasets.

Endpoints

POST

/v1/data-qualities/computations
GET

/v1/data-qualities/computations/{computationId}
GET

/v1/data-qualities/global-results

Triggers the computation of data quality.

Facts

Rate limit	Special (10 requests per minute)
Categories

Request Body

Required

application/json

Represents a data quality computation request. The `connectionId` attribute is optional for file-based datasets. If no sampling parameters (`executionMode`, `sampleMode`, `sampleSize`) are provided, the following default configuration is used: - `executionMode: PULLUP` - `sampleMode: ABSOLUTE` - `sampleSize: 1000`

application/jsonobject

Represents a data quality computation request. The connectionId attribute is optional for file-based datasets. If no sampling parameters (executionMode, sampleMode, sampleSize) are provided, the following default configuration is used: - executionMode: PULLUP - sampleMode: ABSOLUTE - sampleSize: 1000
Show application/json properties
- datasetIdstring
  
  The ID of the dataset
  
  pattern = "^[0-9a-zA-Z-]{1,36}$"
- connectionIdstring
  
  The ID of the connection
  
  pattern = "^[0-9a-zA-Z-]{1,36}$"
- sampleModestring
  
  Specifies how the dataset is sampled. ABSOLUTE represents a fixed number of rows, while RELATIVE refers to a percentage of the total dataset rows.
  
  Can be one of: "ABSOLUTE""RELATIVE"
- sampleSizeinteger
  
  The actual value of the selected sampling method size (either a fixed number for ABSOLUTE mode or a percentage for RELATIVE mode).
  
  minimum = 1, format = int64
- executionModestring
  
  Specifies where the data quality computation takes place. In PUSHDOWN mode, it runs within the Cloud Data Warehouse (e.g., Snowflake, Databricks), whereas in PULLUP mode, it runs in Qlik Cloud.
  
  Can be one of: "PUSHDOWN""PULLUP"

Responses

202

application/json

Accepted

The ID of the computation

application/jsonobject

The ID of the computation
Show application/json properties
- computationIdstring
  Required

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

401

application/json

User does not have valid authentication credentials.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

403

application/json

User does not have access to the resource.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

500

application/json

Internal Server Error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

503

application/json

Requested service is not available.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

POST /v1/data-qualities/computations

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-qualities/computations" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"datasetId":"669144f5aa2d642638ef1dd0","sampleMode":"ABSOLUTE","sampleSize":10000,"connectionId":"2b855c3d-426c-4aac-90cf-0edf9fc294d3","executionMode":"PULLUP"}'

const https = require('https')
  const data = JSON.stringify({"datasetId":"669144f5aa2d642638ef1dd0","sampleMode":"ABSOLUTE","sampleSize":10000,"connectionId":"2b855c3d-426c-4aac-90cf-0edf9fc294d3","executionMode":"PULLUP"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-qualities/computations',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "datasetId": "669144f5aa2d642638ef1dd0",
  "sampleMode": "ABSOLUTE",
  "sampleSize": 10000,
  "connectionId": "2b855c3d-426c-4aac-90cf-0edf9fc294d3",
  "executionMode": "PULLUP"
}

Response

{
  "computationId": "string"
}

Returns the execution status of a data quality computation.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Path Parameters

computationIdstring
Required

The ID of the computation

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- statusstring
  Required
  
  Can be one of: "PROFILE_REQUESTED""PROFILE_FAILED""REQUESTED""SUBMITTED""SUCCEEDED""FAILED"

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

401

application/json

User does not have valid authentication credentials.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

403

application/json

User does not have access to the resource.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

404

application/json

Computation is not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

500

application/json

Internal Server Error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

503

application/json

Requested service is not available.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

GET /v1/data-qualities/computations/{computationId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-qualities/computations/{computationId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-qualities/computations/{computationId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "status": "PROFILE_REQUESTED"
}

Returns the global data results for a dataset, including counts of total, valid, invalid, and empty sample cells.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Query Parameters

datasetIdstring
Required

The ID of the dataset

pattern = "^[0-9a-zA-Z-]{1,36}$"
connectionIdstring

The connection ID

pattern = "^[0-9a-zA-Z-]{1,36}$"

Responses

200

application/json

Ok response

application/jsonobject
Show application/json properties
- datasetIdstring
  Required
  
  The ID of the dataset
- qualitiesarray of objects
  Required
  
  Show qualities properties
  
  qualityobject
  Required
  
  Show quality properties
  
  emptyinteger
  Required
  
  Number of empty sample cells
  
  format = int64
  
  totalinteger
  Required
  
  Total number of cells in the sample
  
  format = int64
  
  validinteger
  Required
  
  Number of valid sample cells
  
  format = int64
  
  invalidinteger
  Required
  
  Number of invalid sample cells
  
  format = int64
  
  updatedAtstring
  Required
  
  format = "date-time"
  
  connectionIdstring
  Required
  
  The ID of the connection

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

401

application/json

User does not have valid authentication credentials.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

403

application/json

User does not have access to the resource.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

404

application/json

Resource does not exist.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

500

application/json

Internal Server Error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

503

application/json

Requested service is not available.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  statusstring
- traceIdstring

GET /v1/data-qualities/global-results

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-qualities/global-results" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-qualities/global-results',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "datasetId": "string",
  "qualities": [
    {
      "quality": {
        "empty": 42,
        "total": 42,
        "valid": 42,
        "invalid": 42,
        "updatedAt": "2018-10-30T07:06:22Z"
      },
      "connectionId": "string"
    }
  ]
}

Data qualities

Endpoints

Trigger data quality computation

Facts

Request Body

Responses

202

400

401

403

500

503

Request

Response

Get data quality computation status

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Response

Get global data quality

Facts

Query Parameters

Responses

200

400

401

403

404

500

503

Response