Trust scores

Download OpenAPI spec

The Qlik Trust Score™ helps you answer the question “How trustable is my dataset?”. This global quality indicator aggregates several metrics into a single and easy-to-understand score, providing visibility on the health of individual datasets through an overall score and a per-axis and per-metric breakdown.

Retrieve Trust Scores in bulk

Returns the current Trust Score for up to 100 datasets in a single request. Each result includes the overall score, per-axis breakdown (weight, score, enabled state), and per-metric details. Datasets with no computed Trust Score are omitted from the response. Requires dataset:read and dataquality:read permissions.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required

List of dataset IDs to retrieve Trust Scores for. Maximum 100 IDs per request.

  • application/json object

    Request body for batch-filtering Trust Score results by dataset IDs.

    Show application/json properties
    • datasetIds array of strings
      Required

      List of dataset IDs to retrieve Trust Scores for. Maximum 100 IDs per request.

      minItems = 1, maxItems = 100

    • recomputeUsage boolean

      When true, refreshes the USAGE and TIMELINESS axes from source before returning the Trust Scores.

      default = false

Responses

200

Trust Score results for the requested datasets. Datasets with no computed Trust Score are omitted.

  • application/json object

    Trust Score results for the requested datasets. Datasets with no computed Trust Score are omitted.

    Show application/json properties
    • data array of objects
      Required

      List of Trust Score results, one entry per dataset found.

      Show data properties
      • axes array of objects
        Required

        Per-axis breakdown of the Trust Score.

        Show axes properties
        • id string
          Required

          Defines the axis of the Trust Score.

          Can be one of: "VALIDITY""COMPLETENESS""USAGE""DISCOVERABILITY""ACCURACY""DIVERSITY""TIMELINESS"

        • score number

          Computed score for this axis [0, 100]. Omitted when axis is not applicable.

        • weight integer
          Required

          Defines the weight of the axis or metric in the Trust Score.

          minimum = 0, maximum = 100, format = int32

        • enabled boolean

          Whether this axis is enabled in the tenant configuration. Disabled axes have a weight of 0 and do not affect the overall score.

        • metrics array of objects
          Required

          Per-metric breakdown contributing to this axis score.

          Show metrics properties
          • id string
            Required

            Defines the metric of the axis in the Trust Score.

            Can be one of: "VALIDITY_QUALITY""COMPLETENESS_QUALITY""USAGE_APPS""USAGE_APP_VIEWS""DISCOVERABILITY_DESCRIPTION""DISCOVERABILITY_TAGS""DISCOVERABILITY_ACTIVATED""DISCOVERABILITY_FIELD_DESCRIPTION""DISCOVERABILITY_FIELD_TAGS""ACCURACY_QUALITY""DIVERSITY_SOURCE""DIVERSITY_VOLUME""DIVERSITY_EVENNESS""TIMELINESS_FRESHNESS"

          • score number

            Computed score for this metric [0, 100]. Omitted when metric is not applicable.

          • weight integer
            Required

            Defines the weight of the axis or metric in the Trust Score.

            minimum = 0, maximum = 100, format = int32

        • applicable boolean

          Whether this axis is applicable for the dataset. An axis may be enabled but not applicable (for example, TIMELINESS when no freshness threshold is set).

        • previousScore number

          Axis score from the previous computation, for change tracking.
      • score number
        Required

        Overall weighted Trust Score across all enabled axes [0, 100].

      • datasetId string
        Required

        Unique identifier of the dataset this score belongs to.

      • updatedAt string
        Required

        Timestamp of the last Trust Score computation for this dataset.

        format = "date-time"

      • previousScore number

        Overall Trust Score from the previous computation, for change tracking.

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
      • status 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
      • status 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
      • status 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
      • status 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
      • status string
    • traceId string
POST /api/data-governance/trust-scores/results/data-sets/actions/filter 
import { createQlikApi } from '@qlik/api'


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


await qlik.dataGovernance.trustScores.filterDatasetsTrustScore(
  {
    datasetIds: [
      'Jjk5NNHiUObQe8xTyeLgP5nQjKTpEr8R',
    ],
  },
)
qlik data-governance trust-score result data-set filter \
  --datasetIds 'Jjk5NNHiUObQe8xTyeLgP5nQjKTpEr8R'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/trust-scores/results/data-sets/actions/filter" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"datasetIds":["Jjk5NNHiUObQe8xTyeLgP5nQjKTpEr8R"],"recomputeUsage":false}'

Example Response

{
  "data": [
    {
      "axes": [
        {
          "id": "TIMELINESS",
          "score": 42,
          "weight": 50,
          "enabled": true,
          "metrics": [
            {
              "id": "TIMELINESS_FRESHNESS",
              "score": 42,
              "weight": 50
            }
          ],
          "applicable": true,
          "previousScore": 42
        }
      ],
      "score": 42,
      "datasetId": "Jjk5NNHiUObQe8xTyeLgP5nQjKTpEr8R",
      "updatedAt": "2018-03-20T09:12:28Z",
      "previousScore": 42
    }
  ]
}