Get existing metric types - 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

This endpoint retrieves a list of existing metric types, supporting flexible querying and pagination.

HTML

GET https://hostname/v2/catalog/metric-types

Request

Query parameters

Key Required Type Description
filter No string

ilter the results by specifying one or more filters.

Filter operators:

  • eq Equal to
  • ne Not equal to
  • lt Less than
  • le Less than or equal to
  • gt Greater than
  • ge Greater than or equal to
  • in In a list of comma separated values
  • ni Not in a list of comma separated values
  • ct Contains a value
  • sw Starts with a value
  • ew Ends with a value
  • ex Exists (only accepts Boolean (true or false) values)

By default, multiple filter expressions are combined in an AND expression. Filter expressions can be grouped by appending the optional group index (:0, :1,…,, :n ) to each filter expression. Filters in the same group are combined using AND while different groups are combined using OR.

For example, these filter expressions are in two different groups (0 and 1), so the combined expressions return results where name is either Bob or Alice.

Case sensitivity

Filter expressions are case-insensitive by default. They can be made case-sensitive by adding the search=true query parameter (if supported). Using search=true query parameter (where applicable) will also improve performance with complex filter expressions, such as those specified by the contains operator.
sort No string

Sort the results by a field in ascending or descending order.

Specify asc to sort in ascending order (0–9, a–z) or desc to sort in descending order (z–a, 9–0). Specify multiple sort fields with multiple sort parameters. Sorting is applied in the same order that sort query parameters are ordered.

Example: To first sort by field1 in ascending order and then by field2 in descending order, combine two sort expressions in the query expression:
?sort=asc(field1)&sort=desc(field2)
offset No number The number of records to skip before returning results.
limit No number The number of records to return per page.
includeTotal No boolean

Return a count of the total number of records that match the specified filter expression regardless of the number of number of records returned in the response page.

  • True — Return the total count of records that match the specified filter.
  • False — Do not return the count (default).

The count is returned by the total property in the response body. If the totalOverflow property is set to true in the response body, then the total count is an estimate that may exceed the actual number of records returned by the search.

Response

Response body properties

Ancestors Property Required Type Description
  data   array(object) Data envelope for response.
data id No string
  • Format: objectId
  • Pattern: ^[a-fA-F\d]{24}$
data effectiveDate No string
  • Format: date-time
data shouldRunScoring No boolean

This property may be set to true or false.
data workspaceId No string  
data name No string  
data overridability No string

This property is an enumerated string type (enum) set to one of these values:

  • None
  • All
data description No string  
data valueType No string

This property is an enumerated string type (enum) set to one of these values:

  • Numeric
  • Percentage
  • Complex
  • SemanticType
  • String
data xref No array  
data promote No boolean

This property may be set to true or false.
data testConfiguration No object  
data/testConfiguration engine Yes string

This property is an enumerated string type (enum) set to one of these values:

  • None
  • Catalog
  • DIS
  • Trillium
data/testConfiguration type No string
  • Maximum length: 50 characters
data/testConfiguration conditions No array  
data/testConfiguration entrySource Yes string

This property is an enumerated string type (enum) set to one of these values:

  • AutoGenerated
  • UserProvided
data/testConfiguration testType No string

This property is an enumerated string type (enum) set to one of these values:

  • Field
  • Relationship
  • Ownership
  • Predicate
data state No string

This property is an enumerated string type (enum) set to one of these values:

  • Active
  • Inactive
  • Deleted
data createdBy No string  
data createdAt No string
  • Format: date-time
data updatedBy No string  
data updatedAt No string
  • Format: date-time

Response examples

Example status code responses for this method are shown here.

Examples
"data": [
  {
    "id": "66d1fec8ffd4bd92f11945d6",
    "workspaceId": "v9jsnlpmw4vnmnfh",
    "name": "blankPercentage",
    "overridability": "None",
    "valueType": "Percentage",
    "promote": "true",
    "state": "Active",
    "effectiveDate": "2025-08-20T12:26:41.053Z",
    "description": "Stores the percentage of blanks for a given asset",
    "xref": "ScoreMetric=blankPercentage",
    "xref": "{DIS Technical}::=blankPercentage",
    "testConfiguration"": {
      "engine": "DIS",
      "entrySource": "AutoGenerated",
      "type": "MetricBasedConfig",
      "conditions": [
         (totalCount-blankCount)/totalCount
      ]
   }
    "createdBy": "template",
    "createdAt": "2024-08-30T17:18:00.645Z",
    "updatedBy": "template",
    "updatedAt": "2025-09-23T10:12:12.361Z"
  }
]
"links"": {
  "self": "https://api.cloud.precisely.com/metric-types"
}
 
"value"": {
  "statusCode": "400",
  "error": "Bad Request",
  "message": "Bad Request"
}
 
"value"": {
  "statusCode": "401",
  "error": "Unauthorized",
  "message": "Authentication required"
}
 
"value"": {
  "statusCode": "404",
  "error": "Not Found",
  "message": "Resource not found"
}
 
"value"": {
  "statusCode": "429",
  "error": "Too Many Requests",
  "message": "Rate limit exceeded"
}
 
"value"": {
  "statusCode": "500",
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}
 
"value"": {
  "statusCode": "503",
  "error": "Service Unavailable",
  "message": "Service temporarily unavailable"
}
 
"value"": {
  "statusCode": "504",
  "error": "Gateway Timeout",
  "message": "Request timeout"
}