List rule results or filter by asset ID - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Returns a paginated list of asset-level scoring results for the given rule. Includes score, band, pass/fail counts and paging metadata.

HTML

GET https://hostname/v1/quality/rules/{ruleId}/results

OR

GET https://hostname/v1/quality/rules/{ruleId}/results?{assetId}

Request

Path parameters

Key Required Type Description
ruleId Yes string

ID of the rule to retrieve

Query parameters

Key Required Type Description
assetId No string Asset ID to filter results
page No integer Page number
limit No integer Number of items per page

Response

The successful response returns the paginated list of asset-level scoring results for the specified rule.

Response body properties

Ancestors Property Required Type Description
  items Yes array[object] Scoring results for the specified rule.
items assetName Yes string  
items assetPath Yes string  
items assetId Yes string  
items parentAssetId Yes string  
items score Yes integer  
items passCount Yes integer  
items totalCount Yes integer  
items failCount Yes integer  
items evaluateCount Yes integer  
items capturedFailedRecords Yes boolean  
items isSampleAvailable Yes boolean  
items catalogType Yes string  
items lastRunAt Yes string  
items scoreBands Yes array  
items/scoreBands label Yes string  
items/scoreBands color Yes string  
items/scoreBands minimumValue Yes string  
  pageSize Yes integer
  • Minimum: 1
  currentPage Yes integer
  • Minimum: 1
  totalItems Yes integer
  • Minimum: 0
  totalPages Yes integer
  • Minimum: 0

Response examples

Example status code responses for this method are shown here.

Examples

Rule results page returned successfully.

{
  "items": [
    {
      "assetName": "order_id",
      "assetPath": "Databricks_Automationdb > kt_metastore > test_freshness > customer_info > order_id",
      "assetId": "6944e48e749df0beee683324",
      "parentAssetId": "6944e48e749df0beee68331b",
      "score": 0,
      "passCount": 0,
      "totalCount": 3,
      "failCount": 0,
      "evaluateCount": 0,
      "capturedFailedRecords": true,
      "isSampleAvailable": false,
      "catalogType": "Field",
      "lastRunAt": "2025-12-19T05:48:28.666Z",
      "scoreBands": {
        "label": "Poor",
        "color": "red",
        "minimumValue": 0
      }
    }
  ],
  "totalPages": 1,
  "totalItems": 1,
  "currentPage": 1,
  "pageSize": 1
}
 
{
   "type":"about:blank",
   "title":"Bad Request",
   "status":"400",
   "detail":"Page number must be greater than or equal to 1 or invalid rule/asset id.",
   "instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b/results",
   "errorCode":"DIS-QUALITY-RULES-USR-0001"
}
 
{
   "type":"about:blank",
   "title":"Not Found",
   "status":"404",
   "detail":"Rule or asset not found for given ID",
   "instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b/results",
   "errorCode":"DIS-QUALITY-RULES-USR-0003"
}
 
{
   "type":"about:blank",
   "title":"Internal Server Error",
   "status":"500",
   "detail":"An unexpected error occurred on the server",
   "instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b/results",
   "errorCode":"DIS-QUALITY-RULES-SVC-0001"
}