ATataccama
Alerts

Get alert

Retrieve an alert by URN, including the URNs of its findings.

URL-encode the alert URN when placing it in the request path. Each colon (:) becomes %3A.

If an alert groups more than 1000 findings, the findingUrns list is truncated. To get the findings with their attributes, and with pagination, list them with the alertUrn parameter instead (see List findings).

get/data-observability/v1/alerts/{alertUrn}

Request

Path parameters

alertUrnstring uri required

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

The URN of the alert, URL-encoded.

Response

The requested alert.

urnstring uri required

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.

statusstring required

@ExtensibleEnum The alert lifecycle status, taken from the findings:

  • ACTIVE: One or more of the alert's findings are still active.
  • STALE: None of the alert's findings are active, but one or more are stale.
  • INACTIVE: All of the alert's findings are inactive, and the alert has ended.
severitystring required

@ExtensibleEnum The highest severity among the alert's findings: LOW, MEDIUM, HIGH, or CRITICAL.

resolutionstring required

@ExtensibleEnum How your team triaged the alert, as set in the web application:

  • NOT_SET: The resolution has not been decided yet.
  • OPEN: The alert requires attention.
  • EXPECTED: The behavior is acceptable and aligns with expectations.
  • FALSE_POSITIVE: The alert was triggered incorrectly and does not reflect a real problem.
  • RESOLVED: The underlying cause has been addressed.
  • ESCALATED: The alert has been escalated to Jira or ServiceNow.

The resolution can change at any time, even after the alert has ended.

createdAtstring date-time required

When the alert was created.

updatedAtstring date-time

When the alert's findings were last updated. The timestamp tracks updates to the findings only, not changes to the alert's resolution.

The field cannot be filtered on. To detect resolution changes, re-fetch the alerts and compare fields.

resolvedAtstring date-time nullable

When the alert was last resolved. Omitted while the alert is unresolved. The type still admits null so a future implementation may send it explicitly.

findingUrnsFindingUrn[] required

The URNs of the findings grouped under the alert, capped at 1000 entries and not paginated. Returned by Get alert only. If an alert groups more findings than that, the list is truncated.

To get the findings with their attributes, and with pagination, list them with the alertUrn parameter instead (see List findings). To retrieve a single finding, use Get finding.

Example response

{
  "urn": "urn:ata:acme-corp:data-observability:alert:0197f3a0-1111-7c0c-8f9d-3a2b4c5d6e7f",
  "status": "ACTIVE",
  "severity": "LOW",
  "resolution": "NOT_SET",
  "findingUrns": [
    "urn:ata:acme-corp:data-observability:finding:0197f3a0-2222-7c0c-8f9d-3a2b4c5d6e7f"
  ]
}

Changes

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