2022-03-10
▼ ▲ playdeveloperreporting.vitals.anrrate.query
Parameters:
name
Pattern: ^apps/[^/]+/anrRateMetricSet$
Location: path
Description: Required. The resource name. Format: apps/{app}/anrRateMetricSet
Required: Yes
Type: string
Path: v1alpha1/{+name}:query
HTTP Method: POST
Parameter Order: name
Description: Queries the metrics in the metric set.
Flat Path: v1alpha1/apps/{appsId}/anrRateMetricSet:query
▼ ▲ playdeveloperreporting.vitals.anrrate.get
Flat Path: v1alpha1/apps/{appsId}/anrRateMetricSet
Parameters:
name
Location: path
Description: Required. The resource name. Format: apps/{app}/anrRateMetricSet
Required: Yes
Type: string
Pattern: ^apps/[^/]+/anrRateMetricSet$
Path: v1alpha1/{+name}
Parameter Order: name
HTTP Method: GET
Description: Describes the properties of the metric set.
▼ ▲ playdeveloperreporting.vitals.excessivewakeuprate.query
HTTP Method: POST
Path: v1alpha1/{+name}:query
Description: Queries the metrics in the metric set.
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^apps/[^/]+/excessiveWakeupRateMetricSet$
Description: Required. The resource name. Format: apps/{app}/excessiveWakeupRateMetricSet
Flat Path: v1alpha1/apps/{appsId}/excessiveWakeupRateMetricSet:query
Parameter Order: name
▼ ▲ playdeveloperreporting.vitals.excessivewakeuprate.get
Flat Path: v1alpha1/apps/{appsId}/excessiveWakeupRateMetricSet
HTTP Method: GET
Description: Describes the properties of the metric set.
Parameters:
name
Type: string
Required: Yes
Location: path
Description: Required. The resource name. Format: apps/{app}/excessiveWakeupRateMetricSet
Pattern: ^apps/[^/]+/excessiveWakeupRateMetricSet$
Parameter Order: name
Path: v1alpha1/{+name}
▼ ▲ playdeveloperreporting.vitals.errors.counts.get
Path: v1alpha1/{+name}
Flat Path: v1alpha1/apps/{appsId}/errorCountMetricSet
Parameter Order: name
HTTP Method: GET
Description: Describes the properties of the metrics set.
Parameters:
name
Location: path
Pattern: ^apps/[^/]+/errorCountMetricSet$
Required: Yes
Description: Required. Name of the errors metric set. Format: apps/{app}/errorCountMetricSet
Type: string
▼ ▲ playdeveloperreporting.vitals.errors.counts.query
Description: Queries the metrics in the metrics set.
Parameters:
name
Required: Yes
Pattern: ^apps/[^/]+/errorCountMetricSet$
Type: string
Location: path
Description: Required. The resource name. Format: apps/{app}/errorCountMetricSet
Parameter Order: name
HTTP Method: POST
Path: v1alpha1/{+name}:query
Flat Path: v1alpha1/apps/{appsId}/errorCountMetricSet:query
▼ ▲ playdeveloperreporting.vitals.errors.issues.search
HTTP Method: GET
Description: Searches all error issues in which reports have been grouped.
Parameters:
interval.startTime.day
Description: Required. Day of month. Must be from 1 to 31 and valid for the year and month.
Location: query
Format: int32
Type: integer
interval.endTime.day
Location: query
Type: integer
Format: int32
Description: Required. Day of month. Must be from 1 to 31 and valid for the year and month.
interval.startTime.utcOffset
Description: UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
Location: query
Type: string
Format: google-duration
filter
Description: 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](https://google.aip.dev/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 = "walleye" OR deviceModel = "marlin"`. * `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`. ** 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)`
Location: query
Type: string
interval.startTime.nanos
Type: integer
Format: int32
Location: query
Description: Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
interval.endTime.seconds
Location: query
Description: Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
Type: integer
Format: int32
pageToken
Type: string
Location: query
Description: 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.
interval.endTime.utcOffset
Location: query
Description: UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
Type: string
Format: google-duration
interval.startTime.minutes
Type: integer
Location: query
Description: Required. Minutes of hour of day. Must be from 0 to 59.
Format: int32
interval.startTime.seconds
Format: int32
Description: Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
Type: integer
Location: query
interval.startTime.timeZone.version
Type: string
Location: query
Description: Optional. IANA Time Zone Database version number, e.g. "2019a".
pageSize
Location: query
Description: 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.
Format: int32
Type: integer
parent
Required: Yes
Location: path
Description: Required. Parent resource of the error issues, indicating the application for which they were received. Format: apps/{app}
Pattern: ^apps/[^/]+$
Type: string
interval.startTime.timeZone.id
Location: query
Type: string
Description: IANA Time Zone Database time zone, e.g. "America/New_York".
interval.startTime.year
Description: Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
Format: int32
Type: integer
Location: query
interval.endTime.year
Type: integer
Format: int32
Location: query
Description: Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
interval.endTime.month
Format: int32
Description: Required. Month of year. Must be from 1 to 12.
Type: integer
Location: query
interval.endTime.timeZone.version
Type: string
Location: query
Description: Optional. IANA Time Zone Database version number, e.g. "2019a".
interval.endTime.minutes
Format: int32
Description: Required. Minutes of hour of day. Must be from 0 to 59.
Location: query
Type: integer
interval.startTime.hours
Location: query
Format: int32
Description: Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
Type: integer
interval.startTime.month
Location: query
Description: Required. Month of year. Must be from 1 to 12.
Type: integer
Format: int32
interval.endTime.nanos
Format: int32
Description: Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Type: integer
Location: query
interval.endTime.timeZone.id
Type: string
Location: query
Description: IANA Time Zone Database time zone, e.g. "America/New_York".
interval.endTime.hours
Format: int32
Description: Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
Location: query
Type: integer
Flat Path: v1alpha1/apps/{appsId}/errorIssues:search
Parameter Order: parent
Path: v1alpha1/{+parent}/errorIssues:search
▼ ▲ playdeveloperreporting.vitals.errors.reports.search
Parameter Order: parent
Path: v1alpha1/{+parent}/errorReports:search
Flat Path: v1alpha1/apps/{appsId}/errorReports:search
Description: Searches all error reports received for an app.
Parameters:
interval.endTime.seconds
Type: integer
Format: int32
Location: query
Description: Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
interval.startTime.minutes
Type: integer
Format: int32
Description: Required. Minutes of hour of day. Must be from 0 to 59.
Location: query
pageSize
Description: The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 50 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format: int32
Location: query
Type: integer
interval.endTime.day
Description: Required. Day of month. Must be from 1 to 31 and valid for the year and month.
Format: int32
Type: integer
Location: query
interval.endTime.minutes
Description: Required. Minutes of hour of day. Must be from 0 to 59.
Format: int32
Type: integer
Location: query
interval.startTime.year
Description: Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
Type: integer
Format: int32
Location: query
interval.startTime.timeZone.id
Description: IANA Time Zone Database time zone, e.g. "America/New_York".
Location: query
Type: string
filter
Type: string
Location: query
Description: A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error reports that occurred in the requested devices. Example: `deviceModel = "walleye" OR deviceModel = "marlin"`. * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. ** 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 versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`
interval.startTime.nanos
Type: integer
Description: Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Location: query
Format: int32
interval.endTime.utcOffset
Description: UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
Type: string
Format: google-duration
Location: query
interval.startTime.timeZone.version
Type: string
Location: query
Description: Optional. IANA Time Zone Database version number, e.g. "2019a".
interval.startTime.day
Format: int32
Description: Required. Day of month. Must be from 1 to 31 and valid for the year and month.
Location: query
Type: integer
interval.endTime.hours
Type: integer
Format: int32
Location: query
Description: Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
parent
Pattern: ^apps/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. Parent resource of the reports, indicating the application for which they were received. Format: apps/{app}
interval.startTime.seconds
Format: int32
Description: Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
Type: integer
Location: query
interval.endTime.timeZone.version
Type: string
Location: query
Description: Optional. IANA Time Zone Database version number, e.g. "2019a".
pageToken
Description: A page token, received from a previous `SearchErrorReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchErrorReports` must match the call that provided the page token.
Type: string
Location: query
interval.endTime.timeZone.id
Description: IANA Time Zone Database time zone, e.g. "America/New_York".
Type: string
Location: query
interval.startTime.hours
Type: integer
Description: Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
Location: query
Format: int32
interval.endTime.nanos
Location: query
Format: int32
Description: Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Type: integer
interval.startTime.utcOffset
Format: google-duration
Type: string
Description: UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
Location: query
interval.endTime.month
Description: Required. Month of year. Must be from 1 to 12.
Format: int32
Location: query
Type: integer
interval.startTime.month
Location: query
Description: Required. Month of year. Must be from 1 to 12.
Format: int32
Type: integer
interval.endTime.year
Location: query
Description: Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
Type: integer
Format: int32
HTTP Method: GET
▼ ▲ playdeveloperreporting.vitals.crashrate.query
Path: v1alpha1/{+name}:query
Parameter Order: name
HTTP Method: POST
Description: Queries the metrics in the metric set.
Parameters:
name
Description: Required. The resource name. Format: apps/{app}/crashRateMetricSet
Location: path
Required: Yes
Pattern: ^apps/[^/]+/crashRateMetricSet$
Type: string
Flat Path: v1alpha1/apps/{appsId}/crashRateMetricSet:query
▼ ▲ playdeveloperreporting.vitals.crashrate.get
Path: v1alpha1/{+name}
Parameter Order: name
Parameters:
name
Location: path
Description: Required. The resource name. Format: apps/{app}/crashRateMetricSet
Pattern: ^apps/[^/]+/crashRateMetricSet$
Type: string
Required: Yes
Description: Describes the properties of the metric set.
Flat Path: v1alpha1/apps/{appsId}/crashRateMetricSet
HTTP Method: GET
▼ ▲ playdeveloperreporting.vitals.stuckbackgroundwakelockrate.query
Parameters:
name
Pattern: ^apps/[^/]+/stuckBackgroundWakelockRateMetricSet$
Description: Required. The resource name. Format: apps/{app}/stuckBackgroundWakelockRateMetricSet
Location: path
Required: Yes
Type: string
Path: v1alpha1/{+name}:query
HTTP Method: POST
Parameter Order: name
Flat Path: v1alpha1/apps/{appsId}/stuckBackgroundWakelockRateMetricSet:query
Description: Queries the metrics in the metric set.
▼ ▲ playdeveloperreporting.vitals.stuckbackgroundwakelockrate.get
Path: v1alpha1/{+name}
HTTP Method: GET
Parameter Order: name
Description: Describes the properties of the metric set.
Parameters:
name
Pattern: ^apps/[^/]+/stuckBackgroundWakelockRateMetricSet$
Required: Yes
Description: Required. The resource name. Format: apps/{app}/stuckBackgroundWakelockRateMetricSet
Type: string
Location: path
Flat Path: v1alpha1/apps/{appsId}/stuckBackgroundWakelockRateMetricSet
▼ ▲ playdeveloperreporting.anomalies.list
Parameter Order: parent
Path: v1alpha1/{+parent}/anomalies
HTTP Method: GET
Description: Lists anomalies in any of the datasets.
Flat Path: v1alpha1/apps/{appsId}/anomalies
Parameters:
pageSize
Description: Maximum size of the returned data. If unspecified, at most 10 anomalies will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Location: query
Format: int32
Type: integer
parent
Type: string
Description: Required. Parent app for which anomalies were detected. Format: apps/{app}
Required: Yes
Location: path
Pattern: ^apps/[^/]+$
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListErrorReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListErrorReports` must match the call that provided the page token.
filter
Description: Filtering criteria for anomalies. For basic filter guidance, please check: https://google.aip.dev/160. **Supported functions:** * `activeBetween(startTime, endTime)`: If specified, only list anomalies that were active in between `startTime` (inclusive) and `endTime` (exclusive). Both parameters are expected to conform to an RFC-3339 formatted string (e.g. `2012-04-21T11:30:00-04:00`). UTC offsets are supported. Both `startTime` and `endTime` accept the special value `UNBOUNDED`, to signify intervals with no lower or upper bound, respectively. Examples: * `activeBetween("2021-04-21T11:30:00Z", "2021-07-21T00:00:00Z")` * `activeBetween(UNBOUNDED, "2021-11-21T00:00:00-04:00")` * `activeBetween("2021-07-21T00:00:00-04:00", UNBOUNDED)`
Location: query
Type: string