Method: legacySoarDashboard.legacyGetPlaybookMonitoring

Full name: projects.locations.instances.legacySoarDashboard.legacyGetPlaybookMonitoring

Returns a monitoring-focused dashboard view for a specific playbook. It includes metrics like total runs, success rates, average runtime, and trends over time.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacySoarDashboard:legacyGetPlaybookMonitoring

Path parameters

Parameters
instance

string

Required. The instance to get the playbook monitoring for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "workflowIdentifier": string,
  "timeFilter": enum (DashboardTimeRangeTypesEnums)
}
Fields
workflowIdentifier

string

Optional. The workflow identifier.
timeFilter

enum (DashboardTimeRangeTypesEnums)

Optional. The time filter.

Response body

GetLegacySoarPlaybookMonitoringResponse represents the response for getting playbook monitoring.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "payload": {
    object (LegacySoarDashboardDataModel)
  }
}
Fields
payload

object (LegacySoarDashboardDataModel)

Optional. The data model of the dashboard.

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 instance resource:

  • chronicle.legacySoarDashboards.get

For more information, see the IAM documentation.