Findings

List findings

List the findings in your environment.

To list the findings of one alert, use the alertUrn parameter. To restrict the result by finding type or status, use the corresponding query parameters. Each parameter accepts a single value. For multi-value or negated conditions, or to filter by affected asset, use Filter findings instead.

Paging is forward-only.

get/data-observability/v1/findings

Request

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response. Starts at the beginning when omitted.

sizeinteger

Number of findings to return per page.

sortstring

Field to sort by; prefix with a hyphen (-) for descending order. Only createdAt is supported, and only one field per request. Default: -createdAt (newest first).

alertUrnstring uri

URN of a Data Observability alert.

Format: urn:ata:{tenant}:data-observability:alert:{uuid}

Example: urn:ata:acme-corp:data-observability:alert:0197f3a0-1111-7c0c-8f9d-3a2b4c5d6e7f.

Example:urn:ata:acme-corp:data-observability:alert:0197f3a0-1111-7c0c-8f9d-3a2b4c5d6e7f

Restricts the result to findings attached to the given alert.

findingTypestring
Example:job.failure

Restricts the result to findings of the given type, including its subtypes. For example, data.dq also matches data.dq.threshold-breach-rule. For the full taxonomy, see the Findings group description.

statusstring
Example:ACTIVE

@ExtensibleEnum Restricts the result to findings with the given status (ACTIVE, STALE, or INACTIVE).

Response

Paginated list of findings.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "urn": "urn:ata:acme-corp:data-observability:finding:0197f3a0-2222-7c0c-8f9d-3a2b4c5d6e7f",
      "alertUrn": "urn:ata:acme-corp:data-observability:alert:0197f3a0-1111-7c0c-8f9d-3a2b4c5d6e7f",
      "findingType": "job.failure",
      "severity": "LOW",
      "status": "ACTIVE",
      "affectedAssetUrn": "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

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