Get Alerts Count By Resolution Reason

POST 
/api/v1/metrics/alert-count-by-resolution-reason

The API returns number of resolved alerts grouped by the resolution reason. You must have Alert_READ permission to access this endpoint.

Request

application/json

Body

required

filters object[]
List of filters that can be applied for the API
Array [
name ResolutionReasonFilter (string)
Possible values: [alert.resolutionReason, policy.severity, account.groupId, policy.complianceStandardId, cloud.type, policy.type, policy.id, policy.category, cloud.accountId]
operator string
Only operator allowed for this filter is '='.
value string
Filter value.
]
timeRange objectrequired
type string
Type of time ranges supported: [relative]
value object
Relative time supporting past 24 hour, 7 days, 1 month, 3 months, 6 months and 1 year.
unit WidgetTimeUnit (string)
Possible values: [hour, week, month, year]
amount int32

Responses

200

OK

application/json

Schema

Schema

startTime int64

Start time of the time range

endTime int64

End time of the time range

lastScanTs int64

Last scan time of the backend job

dataAvailableFrom int64

Time since when the data is aggregated in the response

value object[]
Alert metrics details
Array [
resolutionReason string
Reason for resolution
count int32
Alert count for the resolution reason
]

Example (from schema)

{
  "startTime": 0,
  "endTime": 0,
  "lastScanTs": 0,
  "dataAvailableFrom": 0,
  "value": [
    {
      "resolutionReason": "string",
      "count": 0
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

error object
code string
message string
target string

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string"
  }
}

401

Unauthorized

403

Forbidden

429

Too Many Requests

Loading...