ATataccama
Data Quality Dashboards

Create DQ dashboard

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.

post/data-quality/v1/dq-dashboards

Request

Request body

namestring required

The name of the DQ dashboard.

descriptionstring nullable

Free-text description of the dashboard.

dqMonitorUrnsDqMonitorUrn[] 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.

Example request

{
  "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"
  ]
}

Response

The created DQ dashboard draft.

draftTypestring 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.

namestring required

The name of the DQ dashboard.

descriptionstring nullable

Free-text description of the dashboard.

dqMonitorUrnsDqMonitorUrn[] 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.

urnstring 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.

Example response

{
  "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.