ATataccama
Data Quality Dimensions

List DQ dimensions

List the DQ dimensions in your environment, together with their dimension results.

The endpoint returns published dimensions only.

In the response, each dimension carries:

  • urn: The dimension's URN, referenced as dqDimensionUrn in rule implementations.
  • results: All dimension results of the dimension, stored inline. The urn of a result is what rule conditions and fallbacks reference as resultUrn.
  • defaultConditionResultUrn and defaultFallbackResultUrn: The results assigned by default to conditions and fallbacks in that dimension.

Paging is forward-only.

get/data-quality/v1/dq-dimensions

Request

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response. Starts at the beginning when omitted. Cursors are opaque; do not construct or parse them.

sizeinteger

Number of dimensions to return per page.

sortstring
Example:name

Comma-separated field names for sorting; prefix with a hyphen (-) for descending order. Defaults to order, the position configured for the dimensions themselves.

Response

Paginated list of DQ dimensions.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "urn": "urn:ata:acme-corp:data-quality:dq-dimension:123e4567-e89b-12d3-a456-426614174000",
      "name": "Completeness",
      "abbreviation": "COM",
      "description": "Measures whether required values are present.",
      "color": "#4CAF50",
      "order": 1,
      "active": true,
      "overallContribution": true,
      "defaultConditionResultUrn": "urn:ata:acme-corp:data-quality:dq-dimension-result:123e4567-e89b-12d3-a456-426614174000",
      "defaultFallbackResultUrn": "urn:ata:acme-corp:data-quality:dq-dimension-result:123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.