ATataccama
Alerts

List alerts

List the alerts in your environment.

To restrict the result by status, severity, or resolution, use the corresponding query parameters. Each parameter accepts a single value. For multi-value or negated conditions, or to filter by finding type, affected asset, or creation date, use Filter alerts instead.

Paging is forward-only.

get/data-observability/v1/alerts

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 alerts 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).

statusstring
Example:ACTIVE

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

severitystring
Example:LOW

@ExtensibleEnum Restricts the result to alerts with the given severity (LOW, MEDIUM, HIGH, or CRITICAL).

resolutionstring
Example:NOT_SET

@ExtensibleEnum Restricts the result to alerts with the given resolution (NOT_SET, OPEN, EXPECTED, FALSE_POSITIVE, RESOLVED, or ESCALATED).

Response

Paginated list of alerts.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "urn": "urn:ata:acme-corp:data-observability:alert:0197f3a0-1111-7c0c-8f9d-3a2b4c5d6e7f",
      "status": "ACTIVE",
      "severity": "LOW",
      "resolution": "NOT_SET"
    }
  ]
}

Changes

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