ATataccama
Data Quality Dashboards

List DQ dashboards

List the DQ dashboards in your environment.

The endpoint returns published dashboards only. A dashboard that exists solely as an unpublished draft is read by URN with ?version=DRAFT instead.

Paging is forward-only. The listing is not isolated from concurrent changes: if dashboards are created or deleted between page requests, some dashboards might be missing from the results.

get/data-quality/v1/dq-dashboards

Request

Query parameters

afterstring

Cursor for forward pagination. Copy the value from meta.next in the previous response as is. Starts at the beginning when omitted. Do not build or decode cursors yourself.

sizeinteger

Number of dashboards to return per page.

sortstring
Example:name

Field to sort by; prefix with a hyphen (-) for descending order. Only name is supported.

Response

Paginated list of DQ dashboards.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "draftType": "NEW",
      "name": "Sales DQ Dashboard",
      "description": "Aggregated quality of all sales-domain monitors",
      "dqMonitorUrns": [
        "urn:ata:acme-corp:data-quality:dq-monitor:123e4567-e89b-12d3-a456-426614174000"
      ],
      "urn": "urn:ata:acme-corp:data-quality:dq-dashboard:123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

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