Method: vitals.errors.issues.search

Searches all error issues in which reports have been grouped.

HTTP request

GET https://playdeveloperreporting.googleapis.com/v1alpha1/{parent=apps/*}/errorIssues:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent resource of the error issues, indicating the application for which they were received.

Format: apps/{app}

Query parameters

Parameters
interval

object (DateTimeInterval)

The date time interval to search error issues. Both start and end must be hour-aligned and use UTC as timezone (or be empty, in which case UTC will be used too).

If set, only error issues with associated error reports that occurred in the interval will be returned. If unspecified, the default interval of the last 24 hours will be used.

pageSize

integer

The maximum number of error issues to return. The service may return fewer than this value.

If unspecified, at most 50 error issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to the request must match the call that provided the page token.

filter

string

A selection predicate to retrieve only a subset of the issues. Counts in the returned error issues will only reflect occurrences that matched the filter.

For filtering basics, please check AIP-160.

** Supported field names:**

  • apiLevel: Matches error issues that occurred in the requested Android versions (specified as the numeric API level) only. Example: apiLevel = 28 OR apiLevel = 29.
  • versionCode: Matches error issues that occurred in the requested app version codes only. Example: versionCode = 123 OR versionCode = 456.
  • deviceModel: Matches error issues that occurred in the requested devices. Example: deviceModel = "google/walleye" OR deviceModel = "google/marlin".
  • deviceBrand: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google".
  • deviceType: Matches error issues that occurred in the requested device types. Example: deviceType = "PHONE".
  • errorIssueType: Matches error issues of the requested types only. Valid candidates: CRASH, ANR. Example: errorIssueType = CRASH OR errorIssueType = ANR.
  • appProcessState: Matches error issues on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: FOREGROUND, BACKGROUND. Example: appProcessState = FOREGROUND.
  • isUserPerceived: Matches error issues that are user-perceived. It is not accompanied by any operators. Example: isUserPerceived.

** Supported operators:**

  • Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison.
  • Logical Operators: Logical operators AND and OR can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The OR operator takes precedence over AND so the use of parenthesis is not necessary when building CNF.

The OR operator is only supported to build disjunctions that apply to the same field, e.g., versionCode = 123 OR errorIssueType = ANR is not a valid filter.

** Examples **

Some valid filtering expressions: * versionCode = 123 AND errorIssueType = ANR * versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH * versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)

orderBy

string

Specifies a field that will be used to order the results.

** Supported dimensions:**

  • errorReportCount: Orders issues by number of error reports.
  • distinctUsers: Orders issues by number of unique affected users.

** Supported operations:**

  • asc for ascending order.
  • desc for descending order.

Format: A field and an operation, e.g., errorReportCount desc

Note: currently only one field is supported at a time.

sampleErrorReportLimit

integer

Optional. Number of sample error reports to return per ErrorIssue. If unspecified, 0 will be used. Note: currently only 0 and 1 are supported.

Request body

The request body must be empty.

Response body

Response with a paginated list of issues that matched the request.

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

JSON representation
{
  "errorIssues": [
    {
      object (ErrorIssue)
    }
  ],
  "nextPageToken": string
}
Fields
errorIssues[]

object (ErrorIssue)

ErrorIssues that were found.

nextPageToken

string

Continuation token to fetch the next page of data.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.