Method: accounts.apps.reports.list
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-13 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-13 UTC."],[[["\u003cp\u003eLists reports, including names and result URIs, for a specified app using the \u003ccode\u003eGET\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of reports and checks using AIP-160 filter strings in query parameters.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters for retrieving large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003ehttps://www.googleapis.com/auth/checks\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eProvides detailed information about the request and response structure, including path and query parameters.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.apps.reports.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListReportsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists reports for the specified app.\n\nBy default, only the [name](/checks/reference/rest/v1alpha/accounts.apps.reports#Report.FIELDS.name) and [resultsUri](/checks/reference/rest/v1alpha/accounts.apps.reports#Report.FIELDS.results_uri) 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](/checks/reference/rest/v1alpha/accounts.apps.reports#Report.FIELDS.name) and [checks](/checks/reference/rest/v1alpha/accounts.apps.reports#Report.FIELDS.checks) fields.\n\n### HTTP request\n\n`GET https://checks.googleapis.com/v1alpha/{parent=accounts/*/apps/*}/reports`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------|\n| `parent` | `string` Required. Resource name of the app. Example: `accounts/123/apps/456` |\n\n### Query parameters\n\n| Parameters ||\n|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `page``Size` | `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. |\n| `page``Token` | `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. |\n| `filter` | `string` Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter reports. Example: `appBundle.releaseType = PRE_RELEASE` |\n| `checks``Filter` | `string` Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter checks within reports. Only checks that match the filter string are included in the response. Example: `state = FAILED` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for [ReportService.ListReports](/checks/reference/rest/v1alpha/accounts.apps.reports/list#google.checks.report.v1alpha.ReportService.ListReports).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"reports\": [ { object (/checks/reference/rest/v1alpha/accounts.apps.reports#Report) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `reports[]` | `object (`[Report](/checks/reference/rest/v1alpha/accounts.apps.reports#Report)`)` The reports for the specified app. |\n| `next``Page``Token` | `string` A token which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/checks`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
