Method: dashboardScheduledReports.fetchHistory

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

Retrieves details of past report runs for a specific scheduled report from the last year, including run count, status, and other success/failure information.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{name}:fetchHistory

Path parameters

Parameters
name

string

Required. The name of the schedule to retrieve history for. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardScheduledReports/{dashboardScheduledReport}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of report generation details to return. The service may return fewer than this value. If unspecified, at most 50 details will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous dashboardScheduledReports.fetchHistory call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

Response message for dashboardScheduledReports.fetchHistory.

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

JSON representation 
{
  "reportGenerationDetails": [
    {
      object (ReportGenerationDetail)
    }
  ],
  "runCounts": integer,
  "nextPageToken": string,
  "totalSize": integer
}
Fields
reportGenerationDetails[]

object (ReportGenerationDetail)

Details about each report generation attempt for the current page. The number of details returned is controlled by the pageSize in the request, up to a maximum of 1000. Results are ordered by reportTime in descending order (newest first). Only report generation details from the last year are returned.
runCounts

integer

Output only. Number of times the schedule has successfully run in the past year. We only retain one year of data.
nextPageToken

string

Output only. A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

Output only. Total number of report generation attempts within the last year, including successful, failed, and in-progress attempts. Unlike runCounts, this field includes all attempts, not just successful ones.

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

  • chronicle.dashboardScheduledReports.fetchHistory

For more information, see the IAM documentation.