Get quality scores for an asset (v2) - 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

Retrieves quality scores for an asset (latest / history).

Returns paginated quality scores for a single asset.

Latest mode (no date parameters): returns the single most recent score record, sorted by effectiveDate in descending (DESC) order.

History mode (fromDate provided): returns all records within the specified date range, sorted by effectiveDate. Sorting is supported in both ascending (ASC) and descending (DESC) order.

If toDate is not provided, it defaults to the current date.

Optional dimensionId narrows results to a specific quality dimension.

HTML

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

Request Parameters

Path parameters

Name Type Required Description
assetId string Yes assetId to fetch asset quality scores.

Query parameters

Name Type Required Description
dimensionId string No Dimension Id to narrow results to a specific quality dimension.
fromDate string No Starts of the requested date range, inclusive (yyyy-MM-dd). Omit for latest mode.
toDate string No End of the requested date range, inclusive (yyyy-MM-dd). Defaults to today when only fromDate is provided.
page integer No Page number (default: 1).
limit integer No Number of results per page, 1–100 (default: 10).

Example URL

GET https://hostname/v2/quality/scores/68c289f1c78ac464af9a3fd0?dimensionId=00000000a00aa0001aaa0a1a&fromDate=2024-01-01&toDate=2024-03-31&page=1&limit=10

Request Body

No request body.

Request Examples

Each example shows how to call this endpoint with the documented method, URL, headers, and request body format.


curl -X GET "/v2/quality/scores/{assetId}" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

fetch("/v2/quality/scores/{assetId}", {
  method: "GET",
  headers: {
        "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
  
})
.then(res => res.json())
.then(data => console.log(data));

import json
import requests

url = "/v2/quality/scores/{assetId}"
headers = {
    "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
payload = None

response = requests.get(url, headers=headers)
print(response.json())

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	body := http.NoBody
	req, _ := http.NewRequest("GET", "/v2/quality/scores/{assetId}", body)
	req.Header.Set("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...")
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body2, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body2))
}

Response

200 - Request successful.

Schema: ScoresQueryResponse (object)

Name Type Required Description
items array[object] No Collection of values returned by this operation.
totalItems integer No totalItems value returned for a successful response.
totalPages integer No totalPages value returned for a successful response.
currentPage integer No currentPage value returned for a successful response.
pageSize integer No pageSize value returned for a successful response.

items[] item fields

Name Type Required Description
assetId string No Unique identifier returned for this resource.
dimensionId string No Unique identifier returned for this resource.
score number No score value returned for a successful response.
scoreBand array[object] No Collection of values returned by this operation.
effectiveDate string No effectiveDate value returned for a successful response.

400 - Invalid request parameters.

Schema: ProblemDetail (object)

Name Type Required Description
type string No type value returned in this response.
title string No title value returned in this response.
status integer No Current processing status for this response.
detail string No Human-readable details returned by the service.
instance string No instance value returned in this response.
properties object No Structured object returned in the response payload.

404 - Identifier for an asset not found for the given.

Schema: ProblemDetail (object)

Name Type Required Description
type string No type value returned in this response.
title string No title value returned in this response.
status integer No Current processing status for this response.
detail string No Human-readable details returned by the service.
instance string No instance value returned in this response.
properties object No Structured object returned in the response payload.

500 - Internal server error.

Schema: ProblemDetail (object)

Name Type Required Description
type string No type value returned in this response.
title string No title value returned in this response.
status integer No Current processing status for this response.
detail string No Human-readable details returned by the service.
instance string No instance value returned in this response.
properties object No Structured object returned in the response payload.

Success responses

Behavior: Returns the most recent quality score for the specified asset and dimension when fromDate is not provided.

{
  "items": [
    {
      "assetId": "68c289f1c78ac464af9a3fd0",
      "dimensionId": "00000000a00aa0001aaa0a1a",
      "score": 88.5,
      "scoreBand": [
        {
          "label": "Excellent",
          "color": "#2ECC71",
          "minimumValue": 80.0
        },
        {
          "label": "Good",
          "color": "#F39C12",
          "minimumValue": 60.0
        },
        {
          "label": "Poor",
          "color": "#E74C3C",
          "minimumValue": 0.0
        }
      ],
      "effectiveDate": "2024-03-01"
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "pageSize": 10
}

Behavior: Returns historical quality scores when fromDate is provided and toDate is omitted. The endpoint treats toDate as today.

{
  "items": [
    {
      "assetId": "68c289f1c78ac464af9a3fd0",
      "dimensionId": "00000000a00aa0001aaa0a1a",
      "score": 87.9,
      "scoreBand": [
        {
          "label": "Excellent",
          "color": "#2ECC71",
          "minimumValue": 80.0
        },
        {
          "label": "Good",
          "color": "#F39C12",
          "minimumValue": 60.0
        },
        {
          "label": "Poor",
          "color": "#E74C3C",
          "minimumValue": 0.0
        }
      ],
      "effectiveDate": "2024-02-26"
    },
    {
      "assetId": "68c289f1c78ac464af9a3fd0",
      "dimensionId": "00000000a00aa0001aaa0a1a",
      "score": 84.1,
      "scoreBand": [
        {
          "label": "Excellent",
          "color": "#2ECC71",
          "minimumValue": 80.0
        },
        {
          "label": "Good",
          "color": "#F39C12",
          "minimumValue": 60.0
        },
        {
          "label": "Poor",
          "color": "#E74C3C",
          "minimumValue": 0.0
        }
      ],
      "effectiveDate": "2024-03-01"
    }
  ],
  "totalItems": 2,
  "totalPages": 1,
  "currentPage": 1,
  "pageSize": 10
}

Behavior: Returns historical quality scores within the requested date range when both fromDate and toDate are provided.

{
  "items": [
    {
      "assetId": "68c289f1c78ac464af9a3fd0",
      "dimensionId": "00000000a00aa0001aaa0a1a",
      "score": 86.4,
      "scoreBand": [
        {
          "label": "Excellent",
          "color": "#2ECC71",
          "minimumValue": 80.0
        },
        {
          "label": "Good",
          "color": "#F39C12",
          "minimumValue": 60.0
        },
        {
          "label": "Poor",
          "color": "#E74C3C",
          "minimumValue": 0.0
        }
      ],
      "effectiveDate": "2024-01-15"
    },
    {
      "assetId": "68c289f1c78ac464af9a3fd0",
      "dimensionId": "00000000a00aa0001aaa0a1a",
      "score": 83.2,
      "scoreBand": [
        {
          "label": "Excellent",
          "color": "#2ECC71",
          "minimumValue": 80.0
        },
        {
          "label": "Good",
          "color": "#F39C12",
          "minimumValue": 60.0
        },
        {
          "label": "Poor",
          "color": "#E74C3C",
          "minimumValue": 0.0
        }
      ],
      "effectiveDate": "2024-01-20"
    }
  ],
  "totalItems": 2,
  "totalPages": 1,
  "currentPage": 1,
  "pageSize": 10
}

Behavior: Returns an empty list when no scores match the provided filters.

{
  "items": [],
  "totalItems": 0,
  "totalPages": 0,
  "currentPage": 1,
  "pageSize": 10
}

Error responses

What to do: Review path, query, header, and body values. Correct invalid fields and retry the request.

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid or malformed request",
  "instance": "https://verify-api-portal-dev.dqcore.cloud.precisely.services/v2/quality/scores/68c289f1c78ac464af9a3fd0",
  "errorCode": "DIS-QUALITY-SCORES-USR-0001"
}

What to do: Confirm the resource identifier and endpoint path, then retry with a valid identifier.

{
  "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/v2/quality/scores/68c289f1c78ac464af9a3fd0",
  "errorCode": "DIS-QUALITY-SCORES-USR-0003"
}

What to do: Retry after a short delay. If the issue persists, collect error identifiers from the payload and contact support.

{
  "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/v2/quality/scores/68c289f1c78ac464af9a3fd0",
  "errorCode": "DIS-QUALITY-SCORES-SVC-0001"
}