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

# List DQ monitors

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

## Request

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

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.

## Query parameters

- `catalogItemUrn` string, 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.
- `after` string
- `size` integer
- `sort` string

## Response `200`

Paginated list of DQ monitors.

- object: Paginated list of DQ monitors.
  - `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` DqMonitorResponse[], required: Array of DQ monitor objects.
    - `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: The name of the DQ monitor. Not unique: multiple monitors can share a name. Identify a monitor by its URN, never by its name.
    - `manualRuleInstances` object, nullable: Rule instances applied manually, keyed by their id (UUID). Each rule instance references the rule it runs (`ruleUrn`) and contains the following sub-entity collections: - `mappings`: Maps rule input attributes (`ruleAttributeUrn`) to attributes of the monitor's own catalog item (`catalogItemAttributeUrn`). - `connectedMappings`: Maps rule input attributes (`ruleAttributeUrn`) to attributes of joined catalog items (`connectedCatalogItemAttributeUrn`). Each connected mapping references the join it goes through (see `joinConfigurations`). - `dqThresholds`: Thresholds used to trigger alert findings for this rule instance. - `parameterValues`: Values assigned to the rule's parameters; each entry references the parameter it sets (`ruleParameterUrn`).
    - `invalidSamplesConfiguration` InvalidSamplesConfiguration
      - `enabled` boolean: Whether invalid samples are collected. Collection also requires invalid samples to be enabled globally in the DQ retention settings; until they are, a monitor with this set to `true` still stores no samples.
      - `sampleSize` integer: How many invalid samples to keep.
    - `termRuleInstances` object: Rule instances applied through glossary terms, as opposed to the manually applied instances in `manualRuleInstances`, keyed by their id (UUID). They exist only on the catalog item's primary DQ monitor. Term rule instances cannot be created or modified through this API. To manage them, [link rules to terms](https://docs.ataccama.com/ataccama-one-agentic/latest/data-quality/add-rules-to-terms.html#add-a-dq-rule-to-a-term) in the web application. Then assign those terms to attributes, either [in the web application](https://docs.ataccama.com/ataccama-one-agentic/latest/data-catalog/detect-terms.html#manual-assignment-process) or through the Catalog API term-assignment batch endpoint.
    - `schedule` ScheduleResponse
      - `cronExpression` string: When the monitor runs.
      - `enabled` boolean: Whether the schedule is active.
      - `ignoreMisfires` boolean: Set to true if you don't want to run scheduled job in case of misfire. False means job will run once (even if there were multiple misfires) as soon as possible.
      - `description` string: Free-text description of the schedule.
      - `timeZone` string: Time zone the cron expression is evaluated in.
      - `startAt` string, date-time: Timestamp to start the schedule from.
      - `endAt` string, date-time: Timestamp to end the schedule or not present for no end.
      - `priority` integer: Scheduling priority.
      - `nextRun` string, date-time: Timestamp of the next scheduled run.
    - `anomalyDetectionConfiguration` AnomalyDetectionConfiguration
      - `enabled` boolean: Whether anomaly detection runs.
    - `profilingConfiguration` ProfilingConfiguration
      - `enabled` boolean: Whether profiling runs.
      - `type` string: @ExtensibleEnum The kind of profiling to run: full profiling (`FULL`) or sample-based profiling.
      - `sampleLimitCount` integer: Absolute cap on profiled records.
      - `sampleLimitPercentage` integer: Percentage cap on profiled records.
    - `exportDefinitions` object, nullable: Configured exports for invalid records, keyed by their id (UUID).
    - `overallDqThresholds` object, nullable: Monitor-level thresholds used to trigger alert findings during processing, keyed by their id (UUID).
    - `joinConfigurations` object, nullable: Joins to other catalog items, defined by foreign-key attribute pairs and used to evaluate DQ rules across joined data, keyed by their id (UUID). See [Cross-table rules](https://docs.ataccama.com/ataccama-one-agentic/latest/data-quality/cross-table-rules.html). A join defines only the connection between the catalog items. The rule input attributes are then mapped onto attributes of the joined catalog item by the connected mappings of each rule instance in `manualRuleInstances`.
    - `dataSlice` DataSliceResponse: A condition that narrows the rows a DQ monitor reads. Only rows matching every predicate are profiled, evaluated, and sampled. Predicates are combined with AND; there is no OR and no nesting. Slices are supported only on catalog items from SQL sources. This is checked when the monitor is published.
      - `label` string: Display name of the slice. If you omit it, each run's results carry a label generated from the attributes and operators only, such as `COUNTRY IN`, never from the values.
      - `predicates` DataSlicePredicateResponse[], required: The conditions, all of which must hold. At least one is required.
        - `attributeUrn` string, uri, required: A URN identifying a catalog attribute resource in the Catalog API. Format: urn:ata:{tenant}:catalog:catalog-attribute:{uuid} Example: urn:ata:acme-corp:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000.
        - `operator` string, required: @ExtensibleEnum The comparison applied to the attribute. See the table above for the value fields each operator uses.
        - `value` string: The value compared against. Numbers are plain decimal strings, such as `5000` or `-12.5`.
        - `listValues` string[]: The values of an `IN_LIST` or `NOT_IN_LIST` condition.
        - `rangeStart` string, date-time: Inclusive start of a `DATE_RANGE`, as an [RFC 3339](https://www.rfc-editor.org/info/rfc3339/) date-time with `Z` or a UTC offset such as `+02:00`.
        - `rangeEnd` string, date-time: Inclusive end of a `DATE_RANGE`, as an [RFC 3339](https://www.rfc-editor.org/info/rfc3339/) date-time with `Z` or a UTC offset such as `+02:00`.
        - `attributeName` string: The attribute's name. Returned in responses only; ignored if sent.
    - `urn` string, uri, required: A URN identifying the DQ monitor resource in the Data Quality API. Format: urn:ata:{tenant}:data-quality:dq-monitor:{uuid} Example: urn:ata:acme-corp:data-quality:dq-monitor:123e4567-e89b-12d3-a456-426614174000.
    - `catalogItemUrn` string, uri, required: 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.

## 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)