Method: accounts.apps.reports.list

  • This method lists reports for a specified app.

  • By default, only the report's name and results URI are returned, but other fields can be included using the fields URL query parameter.

  • The request uses a GET HTTP method with a URL that includes the parent resource name of the app.

  • Optional query parameters like pageSize, pageToken, filter, and checksFilter can be used to control the response.

  • The response body is a JSON object containing a list of reports and a potential token for the next page.

Lists reports for the specified app.

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=reports(name,checks) will return the name and checks fields.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of the app.

Example: accounts/123/apps/456

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of reports to return.

If unspecified, at most 10 reports will be returned. The maximum value is 50; values above 50 will be coerced to 50.
pageToken

string

Optional. A page token received from a previous reports.list call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to reports.list must match the call that provided the page token.
filter

string

Optional. An AIP-160 filter string to filter reports.

Example: appBundle.releaseType = PRE_RELEASE
checksFilter

string

Optional. An AIP-160 filter string to filter checks within reports. 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

The response message for ReportService.ListReports.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "reports": [
    {
      object (Report)
    }
  ],
  "nextPageToken": string
}
Fields
reports[]

object (Report)

The reports for the specified app.
nextPageToken

string

A token which can be sent as pageToken to retrieve the next page.

If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.