---
title: "List DQ dashboards"
method: GET
path: "/data-quality/v1/dq-dashboards"
tags: ["Data Quality Dashboards"]
---

# List DQ dashboards

`GET /data-quality/v1/dq-dashboards`

## Request

- Base URL: `https://your-environment.ataccama.one/api`
- URL: `https://your-environment.ataccama.one/api/data-quality/v1/dq-dashboards`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/data-quality/v1/dq-dashboards/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `after` string
- `size` integer
- `sort` string

## Response `200`

Paginated list of DQ dashboards.

- object
  - `meta` PaginationMetadata, required
    - `next` string: Encoded string representing the next page. Omitted if there are no more pages.
    - `total` integer: Total number of items available across all pages.
  - `data` DqDashboardResponse[], required
    - `draftType` string, required: @ExtensibleEnum The type of the DRAFT version (NONE indicates a PUBLISHED version). It specifies what will happen to the entity if the DRAFT is published. Possible values: - `NEW` — draft proposal to create a new object. - `CHANGE` — draft proposal to change an existing object. - `DELETE` — draft proposal to delete an existing object. - `RESURRECT` — draft proposal to resurrect an already deleted object. - `NONE` — placeholder for a non-existent draft; represents a published version. The value describes the version that was returned, not the entity as a whole: a PUBLISHED version always reports NONE, even when an unpublished draft is waiting. Fetch it with `?version=DRAFT` to see the pending change. An entity that exists only as a draft is not listed and answers a default (published) read with 404.
    - `name` string, required: The name of the DQ dashboard.
    - `description` string, nullable: Free-text description of the dashboard.
    - `dqMonitorUrns` DqMonitorUrn[], required: The URNs of the DQ monitors whose results the dashboard aggregates. The monitors can belong to different catalog items, since a dashboard is not tied to any catalog item. Each monitor must exist and be published, and your API client must have access to it. Otherwise the request is rejected with `404` and no dashboard is created. If a monitor URN appears more than once, the monitor is added once. To find the URNs of the monitors, use [List DQ monitors](#tag/data-quality-monitors/GET/data-quality/v1/dq-monitors).
    - `urn` string, uri, required: A URN identifying the DQ dashboard resource in the Data Quality API. Format: urn:ata:{tenant}:data-quality:dq-dashboard:{uuid} Example: urn:ata:acme-corp:data-quality:dq-dashboard:123e4567-e89b-12d3-a456-426614174000.

## Other responses

- `400`: Bad request. The request parameters or body are invalid.
- `403`: Forbidden. You do not have permission to access the requested resource.

---

[API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)