Data qualities

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

Endpoints

POST

/api/v1/data-qualities/computations
GET

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

/api/v1/data-qualities/global-results

Triggers a full data quality computation for a dataset, running profile calculation followed by data quality assessment. Returns a computationId that can be used to track progress via the computation status endpoint (GET /data-qualities/computations/{computationId}). The computation runs asynchronously. Poll the status endpoint until status is SUCCEEDED or FAILED.

Facts

	Rate limit	Special (10 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST data-governance/data-qualities/computations

Request Body

Required

application/json object
Request payload for triggering a data quality computation. The connectionId is optional for file-based datasets. If none of the sampling parameters are provided, the following defaults apply:
- executionMode: PULLUP
- sampleMode: ABSOLUTE
- sampleSize: 1000
Show application/json properties
- datasetId string
  
  Required
  
  The ID of the dataset
  
  pattern = "^[0-9a-zA-Z-]{1,36}$"
- connectionId string
  
  The ID of the connection
  
  pattern = "^[0-9a-zA-Z-]{1,36}$"
- sampleMode string
  
  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"
- sampleSize integer
  
  The actual value of the selected sampling method size (either a fixed number for ABSOLUTE mode or a percentage for RELATIVE mode). Maximum allowed value for ABSOLUTE mode is 100000.
  
  minimum = 1, maximum = 100000, format = int64
- executionMode string
  
  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

Computation triggered. The response body contains the computationId for tracking progress.

application/json object

Response returned when a data quality computation is successfully triggered.
Show application/json properties
- computationId string
  
  Required
  
  The unique identifier of the triggered computation. Use this value to poll for status.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

POST /api/v1/data-qualities/computations

import { createQlikApi } from '@qlik/api'

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

await qlik.dataQualities.triggerDataQualitiesComputation(
  {
    connectionId:
      '2b855c3d-426c-4aac-90cf-0edf9fc294d3',
    datasetId: '669144f5aa2d642638ef1dd0',
    executionMode: 'PULLUP',
    sampleMode: 'ABSOLUTE',
    sampleSize: 10000,
  },
)

# qlik-cli has not implemented support for POST /api/v1/data-qualities/computations yet.

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

Example Response

{
  "computationId": "string"
}

Retrieves the current execution status of a data quality computation. Poll this endpoint after triggering a computation to determine when results are available. The status field returns one of REQUESTED, SUBMITTED, PROFILE_REQUESTED, SUCCEEDED, FAILED, or PROFILE_FAILED.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	GET data-governance/data-qualities/computations/{computationId}

Path Parameters

computationId string

Required

The unique identifier of the computation, as returned by POST /data-governance/data-qualities/computations.

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

Responses

200

Current execution status of the computation

application/json object
Show application/json properties
- status string
  
  Required
  
  Can be one of: "PROFILE_REQUESTED""PROFILE_FAILED""REQUESTED""SUBMITTED""SUCCEEDED""FAILED"

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

No computation found with the specified computationId.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

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

import { createQlikApi } from '@qlik/api'

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

await qlik.dataQualities.getDataQualitiesComputation(
  '4db06daa-3117-412e-8fb4-b29c937f9a0e',
)

# qlik-cli has not implemented support for GET /api/v1/data-qualities/computations/{computationId} yet.

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

Example Response

{
  "status": "PROFILE_REQUESTED"
}

Retrieves the global quality results for a dataset, showing counts of valid, invalid, empty, and total sample cells.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	GET data-governance/data-qualities/global-results

Query Parameters

datasetId string

Required

The unique identifier of the dataset.

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

The unique identifier of the connection.

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

Responses

200

Global quality results for the dataset, including counts of valid, invalid, empty, and total sample cells per connection.

application/json object
Show application/json properties
- datasetId string
  
  Required
  
  The unique identifier of the dataset.
- qualities array of objects
  
  Required
  
  Show qualities properties
  
  quality object
  
  Required
  
  Show quality properties
  
  empty integer
  
  Required
  
  Number of empty sample cells.
  
  format = int64
  
  total integer
  
  Required
  
  Total number of cells in the sample.
  
  format = int64
  
  valid integer
  
  Required
  
  Number of valid sample cells.
  
  format = int64
  
  invalid integer
  
  Required
  
  Number of invalid sample cells.
  
  format = int64
  
  updatedAt string
  
  Required
  
  Timestamp of the most recent data quality computation for this dataset and connection.
  
  format = "date-time"
  
  connectionId string
  
  Required
  
  The unique identifier of the connection.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

No quality results found for the specified dataset.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/data-qualities/global-results

import { createQlikApi } from '@qlik/api'

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

await qlik.dataQualities.getDataQualitiesGlobalResults(
  { datasetId: 'string' },
)

# qlik-cli has not implemented support for GET /api/v1/data-qualities/global-results yet.

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

Example 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

Example Response

Get data quality computation status

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Example Response

Get global data quality

Facts

Query Parameters

Responses

200

400

401

403

404

500

503

Example Response