NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

Method: organizations.reports.get

Retrieve a custom report definition.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Custom Report name of the form: organizations/{organizationId}/reports/{reportName}

Authorization requires the following IAM permission on the specified resource name:

  • apigee.reports.get

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope: