--- title: "Create DQ dashboard" method: POST path: "/data-quality/v1/dq-dashboards" tags: ["Data Quality Dashboards"] --- # Create DQ dashboard `POST /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: (a function with typed inputs; its response is checked against the schema) Create a DQ dashboard that aggregates the results of the DQ monitors you specify. The dashboard is created as a draft (`draftType: NEW`). Publish it to make it live. Until then, the dashboard is not listed, and retrieving it returns `404 Not Found` unless you request the draft with `?version=DRAFT`. It is created at tenant level and is not bound to a single catalog item. If you send the read-only fields `urn` and `draftType`, they are ignored. A successful request returns `201 Created` with the created dashboard draft. The `Location` header carries the URL of the created dashboard. The URL might be relative. If it is, resolve it against the URL of your request. Save the `urn` for publishing and retrieving the dashboard. Returns `404` when a referenced DQ monitor does not exist, is not published, or is not visible to the caller. No dashboard is created. ## Request body - DqDashboardRequest: A DQ dashboard aggregating the results of multiple DQ monitors. Unlike a rule or monitor draft, a dashboard draft cannot be incomplete. The required fields must be present when you create it. The fields `urn` and `draftType` are read-only and assigned automatically. They appear in responses only and are ignored in request bodies. The `urn` identifies the dashboard. The `draftType` field refers to the version you retrieved. A `DRAFT` version reports what publishing it would do (`NEW`, `CHANGE`, `DELETE`, or `RESURRECT`). When you retrieve the published version, `draftType` is always `NONE`, even if the dashboard has an unpublished change waiting in a draft. Fetch it with `?version=DRAFT` to see the pending change. `POST` creates a draft (`draftType: NEW`); use the publish endpoint to make it live. - `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). ## Response `201` The created DQ dashboard draft. - DqDashboardResponse: A DQ dashboard aggregating the results of multiple DQ monitors. Unlike a rule or monitor draft, a dashboard draft cannot be incomplete. The required fields must be present when you create it. The fields `urn` and `draftType` are read-only and assigned automatically. They appear in responses only and are ignored in request bodies. The `urn` identifies the dashboard. The `draftType` field refers to the version you retrieved. A `DRAFT` version reports what publishing it would do (`NEW`, `CHANGE`, `DELETE`, or `RESURRECT`). When you retrieve the published version, `draftType` is always `NONE`, even if the dashboard has an unpublished change waiting in a draft. Fetch it with `?version=DRAFT` to see the pending change. `POST` creates a draft (`draftType: NEW`); use the publish endpoint to make it live. - `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. - `404`: Not found. The requested resource does not exist. --- [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)