Method: vitals.errors.counts.query

  • Queries error count metrics within a specified app and timeframe, allowing for filtering and aggregation by various dimensions.

  • Utilizes a POST request to https://playdeveloperreporting.googleapis.com/v1alpha1/{name=apps/*/errorCountMetricSet}:query with the app's resource name as a path parameter.

  • Requires a request body specifying the timeline, dimensions, metrics, and optional filtering criteria for the query.

  • The response includes rows of aggregated metrics data and a token for pagination if necessary.

  • Authorization necessitates the https://www.googleapis.com/auth/playdeveloperreporting OAuth scope.

Queries the metrics in the metrics set.

HTTP request

POST https://playdeveloperreporting.googleapis.com/v1alpha1/{name=apps/*/errorCountMetricSet}:query

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name.

Format: apps/{app}/errorCountMetricSet

Request body

The request body contains data with the following structure:

JSON representation 
{
  "timelineSpec": {
    object (TimelineSpec)
  },
  "dimensions": [
    string
  ],
  "metrics": [
    string
  ],
  "pageSize": integer,
  "pageToken": string,
  "filter": string
}
Fields
timelineSpec

object (TimelineSpec)

Specification of the timeline aggregation parameters.

Supported aggregation periods:

  • DAILY: metrics are aggregated in calendar date intervals. The default and only supported timezone is America/Los_Angeles.
dimensions[]

string

Dimensions to slice the data by.

Supported dimensions:

  • apiLevel (string): the API level of Android that was running on the user's device, e.g., 26.
  • versionCode (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral.
  • deviceModel (string): unique identifier of the user's device model.
  • deviceType (string): identifier of the device's form factor, e.g., PHONE.
  • reportType (string): the type of error. The value should correspond to one of the possible values in ErrorType.
  • issueId (string): the id an error was assigned to. The value should correspond to the {issue} component of the issue name.
  • deviceRamBucket (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.).
  • deviceSocMake (string): Make of the device's primary system-on-chip, e.g., Samsung. Reference
  • deviceSocModel (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". Reference
  • deviceCpuMake (string): Make of the device's CPU, e.g., Qualcomm.
  • deviceCpuModel (string): Model of the device's CPU, e.g., "Kryo 240".
  • deviceGpuMake (string): Make of the device's GPU, e.g., ARM.
  • deviceGpuModel (string): Model of the device's GPU, e.g., Mali.
  • deviceGpuVersion (string): Version of the device's GPU, e.g., T750.
  • deviceVulkanVersion (string): Vulkan version of the device, e.g., "4198400".
  • deviceGlEsVersion (string): OpenGL ES version of the device, e.g., "196610".
  • deviceScreenSize (string): Screen size of the device, e.g., NORMAL, LARGE.
  • deviceScreenDpi (string): Screen density of the device, e.g., mdpi, hdpi.
metrics[]

string

Metrics to aggregate.

Supported metrics:

  • errorReportCount (google.type.Decimal): Absolute count of individual error reports that have been received for an app.
  • distinctUsers (google.type.Decimal): Count of distinct users for which reports have been received. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. This value is not rounded, however it may be an approximation.
pageSize

integer

Maximum size of the returned data.

If unspecified, at most 1000 rows will be returned. The maximum value is 100000; values above 100000 will be coerced to 100000.
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

Filters to apply to data. The filtering expression follows AIP-160 standard and supports filtering by equality of all breakdown dimensions and:

  • isUserPerceived (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED.

Response body

Error counts query response.

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

JSON representation 
{
  "rows": [
    {
      object (MetricsRow)
    }
  ],
  "nextPageToken": string
}
Fields
rows[]

object (MetricsRow)

Returned rows.
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.