ATataccama
Data Quality Monitors

List DQ monitors

List the DQ monitors in your environment.

The endpoint returns the latest published version of each monitor.

By default, monitors of all catalog items are returned. To list the monitors of a single catalog item, use the catalogItemUrn parameter.

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

get/data-quality/v1/dq-monitors

Request

Query parameters

catalogItemUrnstring uri

A URN identifying a catalog item resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:catalog-item:{uuid}

Example: urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000.

Example:urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000

Restricts the result to DQ monitors of the given catalog item. Omit to list monitors across all catalog items.

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response.

sizeinteger

Number of monitors to return per page.

sortstring

Comma-separated field names for sorting (for example, name,-createdAt). Prefix with a hyphen (-) for descending order.

Response

Paginated list of DQ monitors.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "draftType": "NEW",
      "schedule": {
        "startAt": "2025-01-15T09:30:00Z",
        "endAt": "2025-01-15T09:30:00Z",
        "nextRun": "2025-01-15T09:30:00Z"
      },
      "profilingConfiguration": {
        "type": "FULL"
      },
      "dataSlice": {
        "label": "Czech and Slovak customers",
        "predicates": [
          {
            "attributeUrn": "urn:ata:acme-corp:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000",
            "operator": "EQ",
            "value": "CZ",
            "listValues": [
              "CZ",
              "SK"
            ],
            "rangeStart": "2026-01-01T00:00:00Z",
            "rangeEnd": "2026-03-31T23:59:59Z",
            "attributeName": "COUNTRY"
          }
        ]
      },
      "urn": "urn:ata:acme-corp:data-quality:dq-monitor:123e4567-e89b-12d3-a456-426614174000",
      "catalogItemUrn": "urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

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