Skip to main content
ZStack
Alerting & Response/Alert Events

GetAlertEventStats

Get aggregate statistics for alert events by severity and resource type

GET/api/v1/alerting/events/stats

Operation ID

GetAlertEventStats

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

  • platformUuid
    String

    Optional platform UUID; when omitted, summarizes the caller's authorized events across all Cloud platforms

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • total
    Integer

    Total number of alert events

    Example: 150

  • firing
    String

    Number of currently firing alerts

    Example: 12

  • acknowledged
    String

    Number of acknowledged alerts

    Example: 5

  • resolved
    String

    Number of resolved alerts

    Example: 133

  • bySeverity
    LinkedHashMap

    Breakdown by alert severity level

    Example: (nested object)

  • byResource
    LinkedHashMap

    Breakdown by resource type

    Example: (nested object)

Change History

View all change history

  • Change Time

    AddedRequest parameters platformUuid
    View API