Method: accounts.apps.reports.get
Stay organized with collections
Save and categorize content based on your preferences.
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.
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\u003eRetrieves a specific report with its name and results URI by default.\u003c/p\u003e\n"],["\u003cp\u003eAllows customization of the response fields using the \u003ccode\u003efields\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eEnables filtering of checks within the report using the \u003ccode\u003echecksFilter\u003c/code\u003e query parameter with AIP-160 syntax.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/checks\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.apps.reports.get\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets a report.\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=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/{name=accounts/*/apps/*/reports/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the report. Example: `accounts/123/apps/456/reports/789` |\n\n### Query parameters\n\n| Parameters ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `checks``Filter` | `string` Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter checks within the report. 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\nIf successful, the response body contains an instance of [Report](/checks/reference/rest/v1alpha/accounts.apps.reports#Report).\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)."]]
