REST Resource: queries.reports

Stay organized with collections Save and categorize content based on your preferences.

Resource: Report

Represents a report.

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

object (ReportKey)

Key used to identify a report.

metadata

object (ReportMetadata)

Report metadata.

params

object (Parameters)

Report parameters.

ReportKey

Key used to identify a report.

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

string (int64 format)

Output only. Query ID.

reportId

string (int64 format)

Output only. Report ID.

ReportMetadata

Report metadata.

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

object (ReportStatus)

Report status.

reportDataStartDate

object (Date)

The starting time for the data that is shown in the report.

reportDataEndDate

object (Date)

The ending time for the data that is shown in the report.

googleCloudStoragePath

string

Output only. The path to the location in Google Cloud Storage where the report is stored.

ReportStatus

Report status.

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

enum (State)

Output only. The state of the report.

finishTime

string (Timestamp format)

Output only. The time when this report either completed successfully or failed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

format

enum (Format)

The file type of the report.

State

The state of the report.

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 associated with a query.