Method: accounts.apps.reports.get

  • This page provides documentation for getting a report using an HTTP GET request.

  • By default, only the name and resultsUri fields are returned in the report.

  • Additional fields can be included in the report by listing them in the fields URL query parameter.

  • The request uses a specific URL format including account, app, and report identifiers.

  • An optional filter can be applied to checks within the report using the checks.filter query parameter.

  • A successful response returns an instance of a Report.

  • This operation requires the https://www.googleapis.com/auth/checks OAuth scope.

Gets a report.

By default, only the name and resultsUri fields are returned. You can include other fields by listing them in the fields URL query parameter. For example, ?fields=name,checks will return the name and checks fields.

HTTP request

GET https://checks.googleapis.com/v1alpha/{name=accounts/*/apps/*/reports/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the report.

Example: accounts/123/apps/456/reports/789

Query parameters

Parameters
checksFilter

string

Optional. An AIP-160 filter string to filter checks within the report. Only checks that match the filter string are included in the response.

Example: state = FAILED

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.