Method: caseAlerts.getAlertOverviewData

Full name: projects.locations.instances.cases.caseAlerts.getAlertOverviewData

Retrieves a view of widgets for a specific alert. Use this method to get a high-level summary of the alert, potentially tailored to a specific playbook view.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1beta/{name}:alertOverviewData

Path parameters

Parameters
name

string

Required. The alert to get overview for. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseAlerts/{caseAlert}:getOverview

Query parameters

Parameters
viewId

string (int64 format)

Optional. The view ID to get overview data for. If not provided, this will return the overview data according to the following criteria: 1. If one or more playbooks have been attached to the alert, the view for the most recent run of the first-attached playbook will be used. 2. If no playbook has been attached to the alert, default alert view will be used.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of OverviewData.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle
  • https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.caseAlerts.get

For more information, see the IAM documentation.