REST Resource: queries.reports

  • A Report represents a single report generated by its parent report, containing key information, metadata, and parameters.

  • ReportKey provides identifying information for a report, including the unique IDs of the query and the report itself.

  • ReportMetadata contains the status of the report, the start and end dates of the report data range, and the Google Cloud Storage path if the report is done.

  • ReportStatus describes the generation state of a report, including its state, finish time, and format.

  • The State enum indicates the possible states of report generation: UNSPECIFIED, QUEUED, RUNNING, DONE, or FAILED.

Resource: Report

A single report generated by its parent report.

JSON representation 
{
  "key": {
    object (ReportKey)
  },
  "metadata": {
    object (ReportMetadata)
  },
  "params": {
    object (Parameters)
  }
}
Fields
key

object (ReportKey)

The key information identifying the report.
metadata

object (ReportMetadata)

The metadata of the report.
params

object (Parameters)

The parameters of the report.

ReportKey

Identifying information of a report.

JSON representation 
{
  "queryId": string,
  "reportId": string
}
Fields
queryId

string (int64 format)

Output only. The unique ID of the query that generated the report.
reportId

string (int64 format)

Output only. The unique ID of the report.

ReportMetadata

The metadata of a report.

JSON representation 
{
  "status": {
    object (ReportStatus)
  },
  "reportDataStartDate": {
    object (Date)
  },
  "reportDataEndDate": {
    object (Date)
  },
  "googleCloudStoragePath": string
}
Fields
status

object (ReportStatus)

The status of the report.
reportDataStartDate

object (Date)

The start date of the report data date range.
reportDataEndDate

object (Date)

The end date of the report data date range.
googleCloudStoragePath

string

Output only. The location of the generated report file in Google Cloud Storage.

This field will be absent if status.state is not DONE.

ReportStatus

The status of a report.

JSON representation 
{
  "state": enum (State),
  "finishTime": string,
  "format": enum (Format)
}
Fields
state

enum (State)

Output only. The state of the report generation.
finishTime

string (Timestamp format)

Output only. The timestamp of when report generation finished successfully or in failure.

This field will not be set unless state is DONE or FAILED.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
format

enum (Format)

The format of the generated report file.

State

Possible states of report generation.

Enums
STATE_UNSPECIFIED Default value when state is not specified or is unknown in this version.
QUEUED The report is queued to run.
RUNNING The report is currently running.
DONE The report has finished running successfully.
FAILED The report has finished running in failure.

Methods

get

 Retrieves a report.

list

 Lists reports generated by the provided query.