The Data Quality Rules API provides real-time control over data quality Rules, enabling automated execution and monitoring.
The Quality Rules API enables real-time access to rule definitions, execution status, profiling controls, and associated quality metrics. These APIs support automated execution, monitoring, and integration with external systems, allowing data engineers to trigger, track, and manage data quality processes without using the user interface.
Version 2 query capabilities
Version 2 of the Data Quality APIs introduces query-based endpoints for retrieving rule results and quality scores. These endpoints support filtering through query parameters, enable both latest and historical retrieval modes, and return a consistent, flat paginated response format.
The following Version 2 endpoints are available:
GET /v2/quality/rules/{ruleId}/resultsGET /v2/quality/scores/{assetId}
Version differences (v1 and v2)
| Aspect | Version 1 | Version 2 |
|---|---|---|
| Retrieval model | Resource-based endpoints | Query-driven retrieval using parameters |
| Primary use | Rule management and basic result retrieval | Filtered and flexible data retrieval across rules and scores |
| Query support | Limited or not supported | Supports filtering through query parameters |
| Result scope | Single resource or predefined responses | Supports latest and historical views |
| Response format | Endpoint-specific response structures | Consistent, flat paginated structure |
Methods
| Method and endpoint | Operation | Description |
|---|---|---|
GET /v1/quality/rules/{ruleId} |
Get rule by ID | Retrieves a rule and its configuration details by ID. Provides scoring bands, metric group info and last run status if available. |
GET /v1/quality/rules/{ruleId}/jobs |
Get rule status or filter by asset ID | Fetches the rule execution status along with asset information. |
GET /v1/quality/rules/{ruleId}/results |
List rule results or filter by asset ID | Returns a paginated list of asset-level scoring results for the given rule. Includes score, band, pass/fail counts and paging metadata. |
GET /v2/quality/rules/{ruleId}/results |
List rule results for an asset (v2) | Retrieves rule asset results (latest / history). |
GET /v1/quality/rules |
List all rules or filter by asset ID | Returns a paginated list of rule summaries. Optionally filters by asset ID if provided. Each summary includes key configuration and execution status. |
POST /v1/quality/rules/{ruleId}/jobs |
Create a job for a rule | Creates a job for the specified rule ID. The asset ID is optional. Returns a job response with a unique job identifier. |
PUT /v1/quality/rules/jobs/{jobId} |
Cancel a running rule job | Cancels a running rule job based on the provided jobId. Returns the cancellation status and error details if any. |
POST /v1/quality/rules |
Create a new quality rule | Creates a new quality rule with the provided details. Returns a status message. |
PATCH /v1/quality/rules |
Update a quality rule | Updates an existing quality rule with the provided details. Returns a status message. |
DELETE /v1/quality/rules/{ruleId} |
Delete a rule by ID | Deletes a rule by given ID. |
GET /v1/quality/profiles |
Get profile of an asset by ID | Fetches the profile and summary for the given assetId. |
POST /v1/quality/profiles/jobs |
Create a job for a profile | Creates a job for the specified profile. Returns a job response with a unique job identifier. |
GET /v1/quality/profiles/jobs/{jobId} |
Get profile run information of a job | Fetches the profile run information of a jobId. |
PUT /v1/quality/profiles/jobs/{jobId} |
Cancel a running profile job | Cancels a running profile job based on the provided jobId. |
GET /v1/quality/scores/{assetId} |
Get quality scores for an asset | Returns the quality scores for the specified asset, including dimension scores, band information, and paging metadata. |
GET /v2/quality/scores |
Get quality scores for an asset (v2) | Retrieves quality scores for an asset (latest / history). |