REST Resource: vitals.errors.issues

Resource: ErrorIssue

A group of related ErrorReports received for an app.

Similar error reports are grouped together into issues with a likely identical root cause.

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 different issues. This could also cause some issues disappearing entirely and being replaced by new ones.

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),
  "cause": string,
  "location": string,
  "errorReportCount": string,
  "distinctUsers": string,
  "distinctUsersPercent": {
    object (Decimal)
  },
  "lastErrorReportTime": string,
  "issueUri": string,
  "firstOsVersion": {
    object (OsVersion)
  },
  "lastOsVersion": {
    object (OsVersion)
  },
  "firstAppVersion": {
    object (AppVersion)
  },
  "lastAppVersion": {
    object (AppVersion)
  },
  "annotations": [
    {
      object (IssueAnnotation)
    }
  ],
  "sampleErrorReports": [
    string
  ]
}
Fields
name

string

Identifier. The resource name of the issue.

Format: apps/{app}/{issue}
type

enum (ErrorType)

Type of the errors grouped in this issue.
cause

string

Cause of the issue.

Depending on the type this can be either:

  • APPLICATION_NOT_RESPONDING: the type of ANR that occurred, e.g., 'Input dispatching timed out'.
  • CRASH: for Java unhandled exception errors, the type of the innermost exception that was thrown, e.g., IllegalArgumentException. For signals in native code, the signal that was raised, e.g. SIGSEGV.
location

string

Location where the issue happened.

Depending on the type this can be either:

  • APPLICATION_NOT_RESPONDING: the name of the activity or service that stopped responding.
  • CRASH: the likely method name that caused the error.
errorReportCount

string (int64 format)

The total number of error reports in this issue (only considering occurrences matching the filters and within the requested time period).
distinctUsers

string (int64 format)

An estimate of the number of unique users who have experienced this issue (only considering occurrences matching the filters and within the requested time period).
distinctUsersPercent

object (Decimal)

An estimated percentage of users affected by any issue that are affected by this issue (only considering occurrences matching the filters and within the requested time period).
lastErrorReportTime

string (Timestamp format)

Start of the hour during which the last error report in this issue 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".
issueUri

string

Link to the issue in Android vitals in the Play Console.
firstOsVersion

object (OsVersion)

The smallest OS version in which this error cluster has occurred in the requested time period (only considering occurrences matching the filters and within the requested time period).
lastOsVersion

object (OsVersion)

The latest OS version in which this error cluster has occurred in the requested time period (only considering occurrences matching the filters and within the requested time period).
firstAppVersion

object (AppVersion)

The earliest (inclusive) app version appearing in this ErrorIssue in the requested time period (only considering occurrences matching the filters).
lastAppVersion

object (AppVersion)

The latest (inclusive) app version appearing in this ErrorIssue in the requested time period (only considering occurrences matching the filters).
annotations[]

object (IssueAnnotation)

List of annotations for an issue. Annotations provide additional information that may help in diagnosing and fixing the issue.
sampleErrorReports[]

string

Output only. Sample error reports which belong to this ErrorIssue. Note: currently a maximum of 1 per ErrorIssue is supported. Format: "apps/{app}/{report}"

IssueAnnotation

Representation of an annotation message for an issue.

JSON representation 
{
  "category": string,
  "title": string,
  "body": string
}
Fields
category

string

Category that the annotation belongs to. An annotation will belong to a single category. Example categories: "Potential fix", "Insight".
title

string

Title for the annotation.
body

string

Contains the contents of the annotation message.

Methods
Searches all error issues in which reports have been grouped.