Method: networks.reports.run

  • Starts the execution of a saved report and allows retrieval of the results asynchronously through polling.

  • Report data can be accessed using OperationsService.GetOperation and FetchReportResultRows once the report generation is finished.

  • Requires the https://www.googleapis.com/auth/admanager OAuth scope for authorization.

  • The report to run is specified via the name path parameter with the format networks/{networkCode}/reports/{reportId}.

  • An empty request body is required for initiating the report execution.

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a reportResult that can be passed to the FetchReportResultRows method to retrieve the report data.

HTTP request

POST https://admanager.googleapis.com/v1/{name}:run

Path parameters

Parameters
name

string

Required. The report to run. Format: networks/{networkCode}/reports/{reportId}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/admanager

For more information, see the OAuth 2.0 Overview.