Method: dashboardScheduledReports.list

Full name: projects.locations.instances.dashboardScheduledReports.list

List Dashboard Scheduled Reports.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/dashboardScheduledReports

Path parameters

Parameters
parent

string

Required. The instance to list DashboardScheduledReports for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of reports to return.
pageToken

string

Optional. A token, which can be sent as pageToken to retrieve the next page.
filter

string

Optional. Filter to apply to the list of reports. Filtering is applied on the displayName and description field of the content proto using substring match (case insensitive).
view

enum (DashboardScheduledReportView)

Optional. The view to apply to the list of reports. If unspecified, the default view will be SCHEDULE_REPORT_VIEW_BASIC.

Request body

The request body must be empty.

Response body

Response message for dashboardScheduledReports.list.

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

JSON representation 
{
  "dashboardScheduledReports": [
    {
      object (DashboardScheduledReport)
    }
  ],
  "nextPageToken": string
}
Fields
dashboardScheduledReports[]

object (DashboardScheduledReport)

The list of DashboardScheduledReports.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.dashboardScheduledReports.list

For more information, see the IAM documentation.

DashboardScheduledReportView

Views to apply to the dashboard scheduled report.

Enums
DASHBOARD_SCHEDULED_REPORT_VIEW_UNSPECIFIED Unspecified dashboard scheduled report view.
DASHBOARD_SCHEDULED_REPORT_VIEW_BASIC Basic dashboard scheduled report view.
DASHBOARD_SCHEDULED_REPORT_VIEW_FULL Full dashboard scheduled report view.