REST Resource: vitals.errors.reports
Stay organized with collections
Save and categorize content based on your preferences.
Resource: ErrorReport
An error report received for an app.
There reports are produced by the Android platform code when a (potentially fatal) error condition is detected. Identical reports from many users will be deduplicated and coalesced into a single ErrorReport.
Required permissions: to access this resource, the calling user needs the View app information (read-only) permission for the app.
| JSON representation |
{
"name": string,
"type": enum (ErrorType),
"reportText": string,
"issue": string,
"eventTime": string,
"deviceModel": {
object (DeviceModelSummary)
},
"osVersion": {
object (OsVersion)
},
"appVersion": {
object (AppVersion)
},
"vcsInformation": string
} |
| Fields |
name |
string
The resource name of the report. Format: apps/{app}/{report}
|
type |
enum (ErrorType)
Type of the error for which this report was generated.
|
reportText |
string
Textual representation of the error report. These textual reports are produced by the platform. The reports are then sanitized and filtered to remove any potentially sensitive information. Although their format is fairly stable, they are not entirely meant for machine consumption and we cannot guarantee that there won't be subtle changes to the formatting that may break systems trying to parse information out of the reports.
|
issue |
string
The issue this report was associated with. Please note: this resource is currently in Alpha. There could be changes to the issue grouping that would result in similar but more recent error reports being assigned to a different issue.
|
eventTime |
string (Timestamp format)
Start of the hour during which the latest event in this error report occurred. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
|
deviceModel |
object (DeviceModelSummary)
A device model on which an event in this error report occurred on.
|
osVersion |
object (OsVersion)
The OS version on which an event in this error report occurred on.
|
appVersion |
object (AppVersion)
The app version on which an event in this error report occurred on.
|
vcsInformation |
string
Version control system information from BUNDLE-METADATA/version-control-info.textproto or META-INF/version-control-info.textproto of the app bundle or APK, respectively.
|
DeviceModelSummary
| JSON representation |
{
"deviceId": {
object (DeviceId)
},
"marketingName": string,
"deviceUri": string
} |
| Fields |
deviceId |
object (DeviceId)
Identifier of the device.
|
marketingName |
string
Display name of the device.
|
deviceUri |
string
Link to the device in Play Device Catalog.
|
DeviceId
| JSON representation |
{
"buildBrand": string,
"buildDevice": string
} |
| Fields |
buildBrand |
string
Value of Build.BRAND.
|
buildDevice |
string
Value of Build.DEVICE.
|
Methods |
|
|
Searches all error reports received for an app. |
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 2025-03-19 UTC.
[null,null,["Last updated 2025-03-19 UTC."],[[["\u003cp\u003eErrorReport resource provides details on errors detected within an Android app, including the error type, a textual description, the time of occurrence, and associated device and app information.\u003c/p\u003e\n"],["\u003cp\u003eError reports from multiple users encountering the same error are combined into a single ErrorReport for analysis.\u003c/p\u003e\n"],["\u003cp\u003eDeviceModelSummary encapsulates information about the device on which an error occurred, like its identifier, marketing name, and a Play Device Catalog link.\u003c/p\u003e\n"],["\u003cp\u003eDeviceId uniquely identifies a device based on its build brand and device properties.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the \u003ccode\u003esearch\u003c/code\u003e method to retrieve and analyze error reports for their app.\u003c/p\u003e\n"]]],["Error reports detail app errors, coalescing identical reports. Access requires *View app information* permission. Key data includes error `type`, `reportText`, associated `issue`, `eventTime`, and device/OS/app versions. Reports are linked to `DeviceModelSummary`, featuring `deviceId`, `marketingName`, and `deviceUri`. The device is identified by `buildBrand` and `buildDevice`. A search method is available to view all reports received for an app.\n"],null,["# REST Resource: vitals.errors.reports\n\n- [Resource: ErrorReport](#ErrorReport)\n - [JSON representation](#ErrorReport.SCHEMA_REPRESENTATION)\n- [DeviceModelSummary](#DeviceModelSummary)\n - [JSON representation](#DeviceModelSummary.SCHEMA_REPRESENTATION)\n- [DeviceId](#DeviceId)\n - [JSON representation](#DeviceId.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: ErrorReport\n---------------------\n\nAn error report received for an app.\n\nThere reports are produced by the Android platform code when a (potentially fatal) error condition is detected. Identical reports from many users will be deduplicated and coalesced into a single ErrorReport.\n\n**Required permissions** : to access this resource, the calling user needs the *View app information (read-only)* permission for the app.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"type\": enum (/play/developer/reporting/reference/rest/v1alpha1/ErrorType), \"reportText\": string, \"issue\": string, \"eventTime\": string, \"deviceModel\": { object (/play/developer/reporting/reference/rest/v1alpha1/vitals.errors.reports#DeviceModelSummary) }, \"osVersion\": { object (/play/developer/reporting/reference/rest/v1alpha1/OsVersion) }, \"appVersion\": { object (/play/developer/reporting/reference/rest/v1alpha1/AppVersion) }, \"vcsInformation\": string } ``` |\n\n| Fields ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The resource name of the report. Format: apps/{app}/{report} |\n| `type` | `enum (`[ErrorType](/play/developer/reporting/reference/rest/v1alpha1/ErrorType)`)` Type of the error for which this report was generated. |\n| `reportText` | `string` Textual representation of the error report. These textual reports are produced by the platform. The reports are then sanitized and filtered to remove any potentially sensitive information. Although their format is fairly stable, they are not entirely meant for machine consumption and we cannot guarantee that there won't be subtle changes to the formatting that may break systems trying to parse information out of the reports. |\n| `issue` | `string` The issue this report was associated with. **Please note:** this resource is currently in Alpha. There could be changes to the issue grouping that would result in similar but more recent error reports being assigned to a different issue. |\n| `eventTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Start of the hour during which the latest event in this error report occurred. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `deviceModel` | `object (`[DeviceModelSummary](/play/developer/reporting/reference/rest/v1alpha1/vitals.errors.reports#DeviceModelSummary)`)` A device model on which an event in this error report occurred on. |\n| `osVersion` | `object (`[OsVersion](/play/developer/reporting/reference/rest/v1alpha1/OsVersion)`)` The OS version on which an event in this error report occurred on. |\n| `appVersion` | `object (`[AppVersion](/play/developer/reporting/reference/rest/v1alpha1/AppVersion)`)` The app version on which an event in this error report occurred on. |\n| `vcsInformation` | `string` Version control system information from BUNDLE-METADATA/version-control-info.textproto or META-INF/version-control-info.textproto of the app bundle or APK, respectively. |\n\nDeviceModelSummary\n------------------\n\nSummary of a device\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deviceId\": { object (/play/developer/reporting/reference/rest/v1alpha1/vitals.errors.reports#DeviceId) }, \"marketingName\": string, \"deviceUri\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `deviceId` | `object (`[DeviceId](/play/developer/reporting/reference/rest/v1alpha1/vitals.errors.reports#DeviceId)`)` Identifier of the device. |\n| `marketingName` | `string` Display name of the device. |\n| `deviceUri` | `string` Link to the device in Play Device Catalog. |\n\nDeviceId\n--------\n\nIdentifier of a device.\n\n| JSON representation |\n|---------------------------------------------------------|\n| ``` { \"buildBrand\": string, \"buildDevice\": string } ``` |\n\n| Fields ||\n|---------------|---------------------------------|\n| `buildBrand` | `string` Value of Build.BRAND. |\n| `buildDevice` | `string` Value of Build.DEVICE. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------------------|-------------------------------------------------|\n| ### [search](/play/developer/reporting/reference/rest/v1alpha1/vitals.errors.reports/search) | Searches all error reports received for an app. |"]]