Get quality scores for an asset - 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 the quality scores for the specified asset, including dimension scores, band information, and paging metadata.

HTML

GET https://hostname/v1/quality/scores/{assetId}

Request

Path parameters

Key Required Type Description
assetId Yes string

Specifies the assetId to fetch asset quality scores.

Query parameters

Key Required Type Description
page No integer Page number
limit No integer Number of items per dimension.

Response

The successful response returns the quality scores for the specified asset, including dimension scores, band information, and paging metadata for the specified asset ID.

Response body properties

Ancestors Property Required Type Description
  assetView Yes object Represents the details of an asset.
assetView assetId Yes string  
assetView assetName Yes string  
assetView assetType Yes string  
assetView assetPath Yes string  
assetView assetTypeId Yes string  
assetView parentId Yes string  
assetView parentName Yes string  
assetView catalogType Yes string  
assetView leaf Yes boolean  
  dimensionScores Yes object Represents aggregated quality scores, band information, and metric group dimensions for an asset.
dimensionScores aggregatedScore   integer  
dimensionScores scoreBands Yes array  
dimensionScores/scoreBands label Yes string  
dimensionScores/scoreBands color Yes string  
dimensionScores/scoreBands minimumValue Yes integer  
dimensionScores dimensions Yes array  
dimensionScores/dimensions id Yes string  
dimensionScores/dimensions name Yes string  
dimensionScores/dimensions targets Yes string  
dimensionScores/dimensions score Yes string  
dimensionScores/dimensions scoreBands Yes array  
dimensionScores/dimensions/scoreBands label Yes string  
dimensionScores/dimensions/scoreBands color Yes string  
dimensionScores/dimensions/scoreBands minimumValue Yes integer  
dimensionScores/dimensions lastRunAt Yes string  
dimensionScores/dimensions childQualityScores Yes array  
dimensionScores/dimensions/childQualityScores assetScores Yes array  
dimensionScores/dimensions/childQualityScores/assetScores totalPages Yes integer Total number of pages available based on page size and total items.
dimensionScores/dimensions/childQualityScores/assetScores totalItems Yes integer Total number of items across all pages.
dimensionScores/dimensions/childQualityScores/assetScores currentPage Yes integer Current page number.
dimensionScores/dimensions/childQualityScores/assetScores pageSize Yes integer Number of items per page.
dimensionScores/dimensions/childQualityScores/assetScores items Yes array  
dimensionScores/dimensions/childQualityScores/assetScores/items id Yes string  
dimensionScores/dimensions/childQualityScores/assetScores/items name Yes string  
dimensionScores/dimensions/childQualityScores/assetScores/items score Yes string  
dimensionScores/dimensions/childQualityScores/assetScores/items description Yes string  
dimensionScores/dimensions/childQualityScores/assetScores/items lastRunAt Yes string  
dimensionScores/dimensions/childQualityScores/assetScores/items scoreBands Yes array  
dimensionScores/dimensions/childQualityScores/assetScores/items/scoreBands label Yes string  
dimensionScores/dimensions/childQualityScores/assetScores/items/scoreBands color Yes string  
dimensionScores/dimensions/childQualityScores/assetScores/items/scoreBands minimumValue Yes integer  
dimensionScores/dimensions/childQualityScores ruleScores Yes array  
dimensionScores/dimensions/childQualityScores/ruleScores id Yes string  
dimensionScores/dimensions/childQualityScores/ruleScores name Yes string  
dimensionScores/dimensions/childQualityScores/ruleScores score Yes string  
dimensionScores/dimensions/childQualityScores/ruleScores description Yes string  
dimensionScores/dimensions/childQualityScores/ruleScores lastRunAt Yes string  
dimensionScores/dimensions/childQualityScores/ruleScores scoreBands Yes array  
dimensionScores/dimensions/childQualityScores/ruleScores/scoreBands label Yes string  
dimensionScores/dimensions/childQualityScores/ruleScores/scoreBands color Yes string  
dimensionScores/dimensions/childQualityScores/ruleScores/scoreBands minimumValue Yes integer  

Response examples

Example status code responses for this method are shown here.

Examples

Successfully retrieved asset quality scores.

{
  "assetView": {
    "assetId": "68c289f1c78ac464af9a3fd0",
    "assetName": "AA",
    "assetType": "[Host].[Database].[Schema].[Table]",
    "assetPath": "syncsort_partner.us-east-1.snowflakecomputing.com > SMS > AUTOMATION > AA",
    "assetTypeId": "660fc5da53199ad437e3c986",
    "parentId": "67e51dc26a9d069e143d2530",
    "parentName": "AUTOMATION",
    "catalogType": "Dataset",
    "leaf": false
  },
  "dimensionScores": {
    "aggregatedScore": 0.5,
    "scoreBands": {
      "label": "Poor",
      "color": "Red",
      "minimumValue": 0
    },
    "dimensions": [
      {
        "id": "66ac9fe6091f80486b23249e",
        "name": "Accuracy",
        "targets": 3,
        "score": 0,
        "scoreBands": {
          "label": "Poor",
          "color": "Red",
          "minimumValue": 0
        },
        "lastRunAt": "2025-11-26T06:27:21.509Z",
        "childQualityScores": {
          "assetScores": {
            "totalPages": 2,
            "totalItems": 2,
            "currentPage": 1,
            "pageSize": 1,
            "items": [
              {
                "id": "68c289f1c78ac464af9a3fd1",
                "name": "FIRSTNAME",
                "score": 0,
                "description": "Field score",
                "lastRunAt": "2025-11-26T06:27:20.503Z",
                "scoreBands": {
                  "label": "Poor",
                  "color": "Red",
                  "minimumValue": 0
                }
              }
            ]
          },
          "ruleScores": [
            {
              "id": "691ac85f91748d99a7db9a0c",
              "name": "null1",
              "score": 0,
              "description": "Rule for accuracy validation",
              "lastRunAt": "2025-11-24T11:44:14.109Z",
              "scoreBands": {
                "label": "Poor",
                "color": "red",
                "minimumValue": 0
              }
            }
          ]
        }
      },
      {
        "id": "66ac9fe6091f80486b23249c",
        "name": "Completeness",
        "targets": 2,
        "score": 1,
        "scoreBands": {
          "label": "Good",
          "color": "Green",
          "minimumValue": 0.9
        },
        "lastRunAt": "2025-12-12T05:25:58.968Z",
        "childQualityScores": {
          "assetScores": {
            "totalPages": 2,
            "totalItems": 2,
            "currentPage": 1,
            "pageSize": 1,
            "items": [
              {
                "id": "68c289f1c78ac464af9a3fd1",
                "name": "FIRSTNAME",
                "score": 1,
                "description": "Field score",
                "lastRunAt": "2025-12-12T05:25:57.949Z",
                "scoreBands": {
                  "label": "Good",
                  "color": "Green",
                  "minimumValue": 0.9
                }
              }
            ]
          },
          "ruleScores": []
        }
      }
    ]
  }
}
{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid asset ID or malformed request",
  "instance": "https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/scores/68c289f1c78ac464af9a3fd1",
  "errorCode": "DIS-QUALITY-SCORES-USR-0001"
}
{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Asset not found for the given ID",
  "instance": "https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/scores/68c289f1c78ac464af9a3fd1",
  "errorCode": "DIS-QUALITY-SCORES-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/scores/68c289f1c78ac464af9a3fd1",
  "errorCode": "DIS-QUALITY-SCORES-SVC-0001"
}