# 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](https://docs.decube.io/use-cases#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](https://docs.decube.io/reports/asset-report-data-quality-scorecard) documentation.

## POST /data\_quality\_scores/report/generate

> Generate Dq Scorecard

```json
{"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect.<REGION>.decube.io/api/v1/data"}],"paths":{"/data_quality_scores/report/generate":{"post":{"tags":["Data Quality Scorecard"],"summary":"Generate Dq Scorecard","operationId":"generate_dq_scorecard_data_quality_scores_report_generate_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DQScorecardGenerateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DQScorecardGenerateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DQScorecardGenerateRequest":{"properties":{"start_date":{"type":"string","format":"date","title":"Start Date","description":"Start date for the data quality scorecard report period"},"end_date":{"type":"string","format":"date","title":"End Date","description":"End date for the data quality scorecard report period"},"source_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Source Id","description":"Optional data source ID to filter the report"},"schema_ids":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Schema Ids","description":"Optional list of schema IDs to include in the report"},"dimensions":{"anyOf":[{"items":{"$ref":"#/components/schemas/Dimension"},"type":"array"},{"type":"null"}],"title":"Dimensions","description":"Optional list of data quality dimensions to include"},"data_owner":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Data Owner","description":"Optional list of data owners to filter by"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"Optional list of tags to filter the data"},"classifications":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Classifications","description":"Whether to include data classifications in the report","default":false},"test_types":{"anyOf":[{"items":{"type":"string","enum":["field_health","custom_sql"]},"type":"array"},{"type":"null"}],"title":"Test Types","description":"Optional test type to filter monitors"}},"type":"object","required":["start_date","end_date"],"title":"DQScorecardGenerateRequest"},"Dimension":{"type":"string","enum":["accuracy","completeness","consistency","timeliness","uniqueness","validity","granularity","others"],"title":"Dimension"},"DQScorecardGenerateResponse":{"properties":{"report_id":{"type":"integer","title":"Report Id"},"status":{"$ref":"#/components/schemas/ReportStatus"}},"type":"object","required":["report_id","status"],"title":"DQScorecardGenerateResponse"},"ReportStatus":{"type":"string","enum":["running","completed","error"],"title":"ReportStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /data\_quality\_scores/report/result

> Get Dq Scorecard Result

```json
{"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect.<REGION>.decube.io/api/v1/data"}],"paths":{"/data_quality_scores/report/result":{"get":{"tags":["Data Quality Scorecard"],"summary":"Get Dq Scorecard Result","operationId":"get_dq_scorecard_result_data_quality_scores_report_result_get","parameters":[{"name":"report_id","in":"query","required":true,"schema":{"type":"integer","title":"Report Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DQScoreCardCompletedResponse"},{"$ref":"#/components/schemas/DQScoreCardRunningOrErrorResponse"}],"title":"Response Get Dq Scorecard Result Data Quality Scores Report Result Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DQScoreCardCompletedResponse":{"properties":{"report_id":{"type":"integer","title":"Report Id"},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"status":{"type":"string","const":"completed","title":"Status"},"data":{"items":{"$ref":"#/components/schemas/DQScorecardDataItem"},"type":"array","title":"Data"}},"type":"object","required":["report_id","start_date","end_date","status","data"],"title":"DQScoreCardCompletedResponse"},"DQScorecardDataItem":{"properties":{"data_owner":{"type":"string","title":"Data Owner"},"qual_id":{"type":"string","title":"Qual Id"},"data_source":{"type":"string","title":"Data Source"},"schema":{"type":"string","title":"Schema"},"table":{"type":"string","title":"Table"},"column":{"type":"string","title":"Column"},"tags":{"type":"string","title":"Tags"},"dimension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimension"},"monitor_name":{"type":"string","title":"Monitor Name"},"monitor_id":{"type":"integer","title":"Monitor Id"},"monitor_description":{"type":"string","title":"Monitor Description"},"monitor_mode":{"type":"string","title":"Monitor Mode"},"test_type":{"type":"string","title":"Test Type"},"filter_mode":{"type":"string","title":"Filter Mode"},"agg_error_row_count":{"type":"integer","title":"Agg Error Row Count"},"agg_total_row_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Agg Total Row Count"},"agg_dq_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Agg Dq Score"},"latest_error_row_count":{"type":"integer","title":"Latest Error Row Count"},"latest_total_row_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Latest Total Row Count"},"latest_dq_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latest Dq Score"}},"type":"object","required":["data_owner","qual_id","data_source","schema","table","column","tags","dimension","monitor_name","monitor_id","monitor_description","monitor_mode","test_type","filter_mode","agg_error_row_count","agg_total_row_count","agg_dq_score","latest_error_row_count","latest_total_row_count","latest_dq_score"],"title":"DQScorecardDataItem"},"DQScoreCardRunningOrErrorResponse":{"properties":{"report_id":{"type":"integer","title":"Report Id"},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"status":{"type":"string","enum":["running","error"],"title":"Status"}},"type":"object","required":["report_id","start_date","end_date","status"],"title":"DQScoreCardRunningOrErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```