Data Quality Scorecard

The Data Quality Scorecard API allows you to generate comprehensive reports of data quality scores across your organization's data assets. Use these endpoints to export data quality metrics for specific time periods, filter by asset metadata, dimensions, and other criteria, and integrate quality reporting into your data governance workflows.

This API uses an asynchronous workflow where you first generate a report request, receive a report ID, and then poll for results until the report is ready for download.

For detailed use cases and workflow examples, see the Data Quality Reporting and Monitoring section in our use cases guide.

To learn more about the Data Quality Scorecard feature in the Decube UI, see the Asset Report - Data Quality Scorecard documentation.

Generate Dq Scorecard

post

Body

start_datestring · dateRequired

Start date for the data quality scorecard report period

end_datestring · dateRequired

End date for the data quality scorecard report period

source_idany ofOptional

Optional data source ID to filter the report

integerOptional

or

nullOptional

schema_idsany ofOptional

Optional list of schema IDs to include in the report

integer[]Optional

or

nullOptional

dimensionsany ofOptional

Optional list of data quality dimensions to include

or

nullOptional

data_ownerany ofOptional

Optional list of data owners to filter by

string[]Optional

or

nullOptional

tagsany ofOptional

Optional list of tags to filter the data

string[]Optional

or

nullOptional

classificationsany ofOptional

Whether to include data classifications in the report

Default: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/data/data_quality_scores/report/generate HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "start_date": "2025-07-31",
  "end_date": "2025-07-31",
  "source_id": 1,
  "schema_ids": [
    1
  ],
  "dimensions": [
    "accuracy"
  ],
  "data_owner": [
    "text"
  ],
  "tags": [
    "text"
  ],
  "classifications": false
}

{
  "report_id": 1,
  "status": "running"
}

Get Dq Scorecard Result

get

Query parameters

report_idintegerRequired

Responses

200

Successful Response

application/json

Responseany of

or

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/data/data_quality_scores/report/result?report_id=1 HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

{
  "report_id": 1,
  "start_date": "2025-07-31",
  "end_date": "2025-07-31",
  "status": "text",
  "data": [
    {
      "data_owner": "text",
      "qual_id": "text",
      "data_source": "text",
      "schema": "text",
      "table": "text",
      "tags": "text",
      "dimension": "text",
      "monitor_name": "text",
      "monitor_id": 1,
      "monitor_description": "text",
      "monitor_mode": "text",
      "test_type": "text",
      "filter_mode": "text",
      "agg_error_row_count": 1,
      "agg_total_row_count": 1,
      "agg_dq_score": 1,
      "latest_error_row_count": 1,
      "latest_total_row_count": 1,
      "latest_dq_score": 1
    }
  ]
}