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_idinteger · nullableOptional

Optional data source ID to filter the report

schema_idsinteger[] · nullableOptional

Optional list of schema IDs to include in the report

data_ownerstring[] · nullableOptional

Optional list of data owners to filter by

classificationsboolean · nullableOptional

Whether to include data classifications in the report

Default: false

Responses

200

Successful Response

application/json

report_idintegerRequired

statusstring · enumRequiredPossible values:

422

Validation Error

application/json

post/data_quality_scores/report/generate

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

{
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "source_id": 1,
  "schema_ids": [
    1
  ],
  "dimensions": [
    "accuracy"
  ],
  "data_owner": [
    "text"
  ],
  "classifications": false,
  "test_types": [
    "field_health"
  ]
}

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

Get Dq Scorecard Result

get

Query parameters

report_idintegerRequired

Responses

200

Successful Response

application/json

or

422

Validation Error

application/json

get/data_quality_scores/report/result

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": "2026-01-01",
  "end_date": "2026-01-01",
  "status": "text",
  "data": [
    {
      "data_owner": "text",
      "qual_id": "text",
      "data_source": "text",
      "schema": "text",
      "table": "text",
      "column": "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
    }
  ]
}