### Query Slow Start Rate Metrics (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Queries the slow start rate metrics within a metric set for an app. ```APIDOC ## POST /v1beta1/{name=apps/*/slowStartRateMetricSet}:query ### Description Queries the metrics in the metric set. ### Method POST ### Endpoint `/v1beta1/{name=apps/*/slowStartRateMetricSet}:query` ``` -------------------------------- ### Query Slow Start Rate Data Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.slowstartrate/query This snippet shows how to query for slow start rate metrics. You can specify dimensions, metrics, filters, and pagination details. ```APIDOC ## Query Slow Start Rate ### Description Retrieves slow start rate metrics for your application, allowing for data slicing by various dimensions and filtering. ### Method POST ### Endpoint /v1beta1/vitals.slowstartrate:query ### Request Body - **timelineSpec** (object) - Optional. Specification of the timeline aggregation parameters. Supported aggregation periods: `DAILY` (timezone: `America/Los_Angeles`). - **dimensions** (array[string]) - Optional. Dimensions to slice the data by. Supported dimensions include `apiLevel`, `versionCode`, `deviceModel`, `deviceBrand`, `deviceType`, `countryCode`, `deviceRamBucket`, `deviceSocMake`, `deviceSocModel`, `deviceCpuMake`, `deviceCpuModel`, `deviceGpuMake`, `deviceGpuModel`, `deviceGpuVersion`, `deviceVulkanVersion`, `deviceGlEsVersion`, `deviceScreenSize`, `deviceScreenDpi`. - **metrics** (array[string]) - Optional. Metrics to aggregate. Supported metrics: `slowStartRate`, `slowStartRate7dUserWeighted`, `slowStartRate28dUserWeighted`, `distinctUsers`. - **filter** (string) - Optional. Filters to apply to data, following AIP-160 standard. - **pageSize** (integer) - Optional. Maximum size of the returned data. Defaults to 1000, maximum is 100000. - **pageToken** (string) - Optional. A page token received from a previous call to retrieve the subsequent page. - **userCohort** (enum) - Optional. User view to select. Supported value: `OS_PUBLIC`. ### Request Example ```json { "timelineSpec": { "aggregationPeriod": "DAILY" }, "dimensions": [ "apiLevel", "deviceBrand" ], "metrics": [ "slowStartRate", "distinctUsers" ], "filter": "deviceBrand = \"google\"", "pageSize": 1000, "userCohort": "OS_PUBLIC" } ``` ### Response #### Success Response (200) - **rows** (array[object]) - Returned rows of data. - **nextPageToken** (string) - Continuation token to fetch the next page of data. #### Response Example ```json { "rows": [ { "apiLevel": "30", "deviceBrand": "google", "slowStartRate": "0.05", "distinctUsers": "1500000" } ], "nextPageToken": "CAE" } ``` ``` -------------------------------- ### Query Slow Start Rate Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.slowstartrate/query Queries the Slow Start Rate metric set to analyze app launch performance. Data can be sliced by dimensions like API level, device model, country, and more. Metrics include slow start rate, daily and rolling averages, and distinct user counts. Supports filtering by dimensions and pagination for large datasets. Requires the `https://www.googleapis.com/auth/playdeveloperreporting` authorization scope. ```APIDOC ## Query Slow Start Rate ### Description Queries the metrics in the metric set. ### Method POST ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/{name=apps/*/slowStartRateMetricSet}:query` ### Path Parameters * **name** (string) - Required. The resource name. Format: apps/{app}/slowStartRateMetricSet ### Authorization Scopes * `https://www.googleapis.com/auth/playdeveloperreporting` ``` -------------------------------- ### Get Slow Start Rate Metric Set (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the slow start rate metric set for an app. ```APIDOC ## GET /v1beta1/{name=apps/*/slowStartRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1beta1/{name=apps/*/slowStartRateMetricSet}` ``` -------------------------------- ### Successful API Response Example Source: https://developers.google.com/play/developer/reporting/metricset-queries A successful API call returns a 200 OK status and the requested data in a structured JSON format. This example shows daily aggregation data for different API levels, including error report counts and distinct users, along with pagination tokens. ```json { rows: [ { aggregation_period: "DAILY" start_time: { year: "2021" month: "7" day: "1" time_zone: "America/Los_Angeles" } dimensions: [{dimension: "apiLevel" int64_value: "20"}] metrics: [ {metric: "errorReportCount" decimal_value: "100"}, {metric: "distinctUsers" decimal_value: "57"}, ] }, { aggregation_period: "DAILY" start_time: { year: "2021" month: "7" day: "1" time_zone: "America/Los_Angeles" } dimensions: [{dimension: "apiLevel" int64_value: "21"}] metrics: [ {metric: "errorReportCount" decimal_value: "123"}, {metric: "distinctUsers" decimal_value: "65"}, ] }, ... ] next_page_token: "eW91IGhhdmUgdG9vIG11Y2ggZnJlZSB0aW1l" } ``` -------------------------------- ### SlowStartRate Resource Source: https://developers.google.com/play/developer/reporting/reference/rest Provides methods to describe and query the slow start rate metric set for your apps. ```APIDOC ## GET /v1alpha1/{name=apps/*/slowStartRateMetricSet} ### Description Describes the properties of the slow start rate metric set. ### Method GET ### Endpoint /v1alpha1/{name=apps/*/slowStartRateMetricSet} ## POST /v1alpha1/{name=apps/*/slowStartRateMetricSet}:query ### Description Queries the slow start rate metrics in the metric set. ### Method POST ### Endpoint /v1alpha1/{name=apps/*/slowStartRateMetricSet}:query ``` -------------------------------- ### Get Slow Start Rate Metric Set Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.slowstartrate/get Retrieves a `SlowStartRateMetricSet` resource, which contains slow start rate data for an app. This is done via a GET request to the specified endpoint. ```APIDOC ## GET apps/*/slowStartRateMetricSet ### Description Retrieves a `SlowStartRateMetricSet` resource containing slow start rate data for an app. ### Method GET ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/{name=apps/*/slowStartRateMetricSet}` ### Parameters #### Path Parameters - **name** (string) - Required. The resource name. Format: apps/{app}/slowStartRateMetricSet ### Request Body The request body must be empty. ### Response #### Success Response (200) - **SlowStartRateMetricSet** - An instance of `SlowStartRateMetricSet` containing the slow start rate data. ### Authorization Scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/playdeveloperreporting` ``` -------------------------------- ### Querying Metric Set Data Source: https://developers.google.com/play/developer/reporting/metricset-queries This example demonstrates how to query specific metrics and dimensions from a metric set for a given application within a specified timeline. ```APIDOC ## POST /v1beta1/apps/{applicationName}/{metricSetName}:query ### Description Queries specific data from a metric set for an application based on provided criteria, such as timeline, dimensions, and metrics. ### Method POST ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/apps/com.example.app/crashRateMetricSet:query` ### Parameters #### Request Body - **timeline_spec** (object) - Specification of the timeline aggregation parameters. - **aggregation_period** (string) - The period for data aggregation (e.g., DAILY). - **start_time** (object) - The start of the time range for the query. - **year** (integer) - **month** (integer) - **day** (integer) - **time_zone** (string) - **end_time** (object) - The end of the time range for the query. - **year** (integer) - **month** (integer) - **day** (integer) - **time_zone** (string) - **dimensions** (array) - String array of dimensions to slice the metrics by. - **metrics** (array) - String array of metrics to aggregate. - **page_size** (integer) - Maximum size of the returned data. Defaults to 1000. Maximum value is 100,000. ### Request Example ```json { "timeline_spec": { "aggregation_period": "DAILY", "start_time": { "year": 2021, "month": 7, "day": 1, "time_zone": "America/Los_Angeles" }, "end_time": { "year": 2021, "month": 7, "day": 3, "time_zone": "America/Los_Angeles" } }, "dimensions": ["apiLevel"], "metrics": ["errorReportCount", "distinctUsers"], "page_size": 10 } ``` ### Response #### Success Response (200) - The response will contain the requested metric data based on the query parameters. The exact structure depends on the metrics and dimensions requested. #### Response Example ```json { "rows": [ { "dimensions": { "apiLevel": "30" }, "metrics": { "errorReportCount": 150, "distinctUsers": 75 } }, { "dimensions": { "apiLevel": "31" }, "metrics": { "errorReportCount": 200, "distinctUsers": 100 } } ], "nextPageToken": "" } ``` ``` -------------------------------- ### Retrieving Metric Set Metadata Source: https://developers.google.com/play/developer/reporting/metricset-queries This example shows how to retrieve the metadata for a specific metric set, such as the crash rate, for a given application. ```APIDOC ## GET /v1beta1/apps/{applicationName}/crashRateMetricSet ### Description Retrieves the metadata for the crash rate metric set for a specified application. ### Method GET ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/apps/com.example.app/crashRateMetricSet` ### Response #### Success Response (200) - **freshness_info** (object) - Information about the freshness of the metric data. - **freshness** (array) - Details about the aggregation period and latest data time. - **aggregation_period** (string) - The period for data aggregation (e.g., DAILY). - **latest_end_time** (object) - The timestamp of the latest data available. - **year** (integer) - **month** (integer) - **day** (integer) - **time_zone** (string) ### Response Example ```json { "freshness_info": { "freshness": [ { "aggregation_period": "DAILY", "latest_end_time": { "year": 2021, "month": 7, "day": 22, "time_zone": "America/Los_Angeles" } } ] } } ``` ``` -------------------------------- ### Request Body Structure for Slow Start Rate Query Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.slowstartrate/query Defines the structure of the JSON request body for querying the slow start rate. It includes fields for timeline specification, dimensions, metrics, filters, pagination, and user cohort. ```json { "timelineSpec": { object (TimelineSpec) }, "dimensions": [ string ], "metrics": [ string ], "filter": string, "pageSize": integer, "pageToken": string, "userCohort": enum (UserCohort) } ``` -------------------------------- ### Response Body Structure for Slow Start Rate Query Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.slowstartrate/query Defines the structure of the JSON response body when querying the slow start rate. It contains a list of metrics rows and a pagination token for subsequent requests. ```json { "rows": [ { object (MetricsRow) } ], "nextPageToken": string } ``` -------------------------------- ### Metric Info Response Example Source: https://developers.google.com/play/developer/reporting/metricset-queries This JSON structure represents the response when retrieving metric set metadata. It includes information about data freshness and aggregation periods. ```json { "freshness_info": { "freshness": [ "aggregation_period": "DAILY" "latest_end_time": { year: "2021" month: "7" day: "22" time_zone: "America/Los_Angeles" } ] } } ``` -------------------------------- ### Retrieve All Anomalies for an App Source: https://developers.google.com/play/developer/reporting/anomalies Use this HTTP GET request to fetch all detected anomalies for a specific application. Ensure the application name is correctly specified. ```HTTP GET https://playdeveloperreporting.googleapis.com/v1beta1/apps/com.example.app/anomalies ``` -------------------------------- ### Retrieve all anomalies for an application Source: https://developers.google.com/play/developer/reporting/anomalies This HTTP GET request specifies the application name parameter and returns the full list of detected anomalies for your application. ```APIDOC ## GET /v1beta1/apps/{application}/anomalies ### Description Retrieves a list of all detected anomalies for a given application. ### Method GET ### Endpoint /v1beta1/apps/{application}/anomalies ### Parameters #### Path Parameters - **application** (string) - Required - The application name in the format `apps/{application}`. ### Response #### Success Response (200) - **anomalies** (array) - A list of anomaly objects. - **name** (string) - The resource name of the anomaly. - **metric_set** (string) - The metric set associated with the anomaly. - **timeline_spec** (object) - Specifies the time period for the anomaly. - **aggregation_period** (string) - The aggregation period (e.g., DAILY). - **start_time** (object) - The start time of the anomaly period. - **year** (integer) - **month** (integer) - **day** (integer) - **time_zone** (object) - **id** (string) - **end_time** (object) - The end time of the anomaly period. - **year** (integer) - **month** (integer) - **day** (integer) - **time_zone** (object) - **id** (string) - **metric** (object) - Information about the metric that triggered the anomaly. - **metric** (string) - The name of the metric (e.g., `anrRate`). - **decimal_value** (object) - **value** (string) - The decimal value of the metric. ### Request Example ``` GET https://playdeveloperreporting.googleapis.com/v1beta1/apps/com.example.app/anomalies ``` ### Response Example ```json { "anomalies": [ { "name": "apps/com.example.app/anomalies/12345", "metric_set": "apps/com.example.app/anrRateMetricSet", "timeline_spec": { "aggregation_period": "DAILY", "start_time": { "year": 2022, "month": 1, "day": 23, "time_zone": { "id": "America/Los_Angeles" } }, "end_time": { "year": 2022, "month": 1, "day": 23, "time_zone": { "id": "America/Los_Angeles" } } }, "metric": { "metric": "anrRate", "decimal_value": { "value": "3.1415926535" } } }, { "name": "apps/com.example.app/anomalies/12345", "metric_set": "apps/com.example.app/crashRateMetricSet", "timeline_spec": { "aggregation_period": "DAILY", "start_time": { "year": 2021, "month": 12, "day": 10, "time_zone": { "id": "America/Los_Angeles" } }, "end_time": { "year": 2021, "month": 12, "day": 10, "time_zone": { "id": "America/Los_Angeles" } } }, "metric": { "metric": "crashRate", "decimal_value": { "value": "2.7182818284" } } } ] } ``` -------------------------------- ### Query Excessive Wakeup Rate Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.excessivewakeuprate/query This example demonstrates how to query the excessive wakeup rate data. You can customize the dimensions, metrics, and filters to suit your analysis needs. ```APIDOC ## POST /v1beta1/vitals/excessivewakeuprate/query ### Description Queries the excessive wakeup rate data. ### Method POST ### Endpoint /v1beta1/vitals/excessivewakeuprate/query ### Parameters #### Request Body - **timelineSpec** (object) - Optional. Specification of the timeline aggregation parameters. Supported aggregation periods: `DAILY` (timezone: `America/Los_Angeles`). - **dimensions[]** (string) - Optional. Dimensions to slice the data by. Supported dimensions include `apiLevel`, `versionCode`, `deviceModel`, `deviceBrand`, `deviceType`, `countryCode`, `deviceRamBucket`, `deviceSocMake`, `deviceSocModel`, `deviceCpuMake`, `deviceCpuModel`, `deviceGpuMake`, `deviceGpuModel`, `deviceGpuVersion`, `deviceVulkanVersion`, `deviceGlEsVersion`, `deviceScreenSize`, `deviceScreenDpi`. - **metrics[]** (string) - Optional. Metrics to aggregate. Supported metrics: `excessiveWakeupRate`, `excessiveWakeupRate7dUserWeighted`, `excessiveWakeupRate28dUserWeighted`, `distinctUsers`. - **filter** (string) - Optional. Filters to apply to data. Follows AIP-160 standard. - **pageSize** (integer) - Optional. Maximum size of the returned data. Defaults to 1000. Maximum value is 100000. - **pageToken** (string) - Optional. A page token, received from a previous call, to retrieve the subsequent page. - **userCohort** (enum) - Optional. User view to select. Supported value: `OS_PUBLIC`. ### Request Example ```json { "timelineSpec": { "aggregationPeriod": "DAILY" }, "dimensions": [ "deviceModel" ], "metrics": [ "excessiveWakeupRate" ], "pageSize": 1000 } ``` ### Response #### Success Response (200) - **rows[]** (object) - Returned rows of data. - **nextPageToken** (string) - Continuation token to fetch the next page of data. #### Response Example ```json { "rows": [ { "deviceModel": "google/coral", "metrics": [ { "value": "0.1" } ] } ], "nextPageToken": "CAQ" } ``` ``` -------------------------------- ### Get Slow Rendering Rate Metric Set (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the slow rendering rate metric set for an app. ```APIDOC ## GET /v1beta1/{name=apps/*/slowRenderingRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1beta1/{name=apps/*/slowRenderingRateMetricSet}` ``` -------------------------------- ### Get Crash Rate Metric Set (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the crash rate metric set for an app. ```APIDOC ## GET /v1beta1/{name=apps/*/crashRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1beta1/{name=apps/*/crashRateMetricSet}` ``` -------------------------------- ### Get StuckBackgroundWakelockRateMetricSet Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.stuckbackgroundwakelockrate/get Retrieves an instance of the StuckBackgroundWakelockRateMetricSet. ```APIDOC ## GET apps/{app}/stuckBackgroundWakelockRateMetricSet ### Description Retrieves an instance of the StuckBackgroundWakelockRateMetricSet. ### Method GET ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/{name=apps/*/stuckBackgroundWakelockRateMetricSet}` ### Parameters #### Path Parameters - **name** (string) - Required. The resource name. Format: apps/{app}/stuckBackgroundWakelockRateMetricSet ### Request Body The request body must be empty. ### Response #### Success Response (200) - **StuckBackgroundWakelockRateMetricSet** (object) - An instance of the StuckBackgroundWakelockRateMetricSet. ### Authorization scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/playdeveloperreporting` ``` -------------------------------- ### Fetch Release Filter Options (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves filtering options for releases for a specific app. ```APIDOC ## GET /v1beta1/{name=apps/*}:fetchReleaseFilterOptions ### Description Describes filtering options for releases. ### Method GET ### Endpoint `/v1beta1/{name=apps/*}:fetchReleaseFilterOptions` ``` -------------------------------- ### StuckBackgroundWakelockRateMetricSet - Get Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.stuckbackgroundwakelockrate Retrieves the StuckBackgroundWakelockRateMetricSet resource for a given application. ```APIDOC ## GET /v1beta1/vitals/stuckBackgroundWakelockRate/{name} ### Description Retrieves the `StuckBackgroundWakelockRateMetricSet` resource for a given application. ### Method GET ### Endpoint `/v1beta1/vitals/stuckBackgroundWakelockRate/{name}` ### Parameters #### Path Parameters - **name** (string) - Required - The resource name of the metric set to retrieve. Format: `apps/{application}/vitals/stuckBackgroundWakelockRate` ### Response #### Success Response (200) - **stuckBgWakelockRate** (StuckBackgroundWakelockRateMetricSet) - The metric set data. #### Response Example ```json { "stuckBgWakelockRate": { "metricSet": { "stuckBgWakelockRate": { "rate": "0.1" }, "stuckBgWakelockRate7dUserWeighted": { "rate": "0.2" }, "stuckBgWakelockRate28dUserWeighted": { "rate": "0.3" }, "distinctUsers": "1000" } } } ``` ``` -------------------------------- ### Query ANR Rate Metrics Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.anrrate/query This outlines how to query metrics for ANR (Application Not Responding) rates. A `POST` request is made to a specific URL, with the app's resource name provided as a path parameter. The request body specifies parameters including `timelineSpec`, `dimensions`, `metrics`, `filter`, `pageSize`, `pageToken`, and `userCohort` to customize the query. The `userCohort` parameter allows you to query `OS_PUBLIC`, `APP_TESTERS` and `OS_BETA` user data. The response contains `rows` of metric data and a `nextPageToken` for pagination. ```APIDOC ## POST /v1beta1/vitals.anrrate:query ### Description Queries ANR (Application Not Responding) rate metrics for a given app. ### Method POST ### Endpoint /v1beta1/vitals.anrrate:query ### Parameters #### Request Body - **timelineSpec** (object) - Required - Specifies the time range for the query. - **dimensions** (array) - Optional - Specifies the dimensions to group the metrics by. - **metrics** (array) - Optional - Specifies the metrics to retrieve. - **filter** (object) - Optional - Specifies filters to apply to the data. - **pageSize** (integer) - Optional - The maximum number of rows to return. - **pageToken** (string) - Optional - A token to retrieve the next page of results. - **userCohort** (string) - Optional - Specifies the user cohort to query. Possible values include `OS_PUBLIC`, `APP_TESTERS`, and `OS_BETA`. ### Request Example ```json { "timelineSpec": { "startTime": "2023-01-01T00:00:00Z", "endTime": "2023-01-31T23:59:59Z" }, "dimensions": ["version", "country"], "metrics": ["anrRate"], "userCohort": "OS_PUBLIC" } ``` ### Response #### Success Response (200) - **rows** (array of objects) - Returned rows of data. - **nextPageToken** (string) - Continuation token to fetch the next page of data. #### Response Example ```json { "rows": [ { "version": "1.0.0", "country": "US", "anrRate": 0.05 } ], "nextPageToken": "CAEQ" } ``` ``` -------------------------------- ### Get LMKRate Metric Set Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.lmkrate/get Retrieves the properties of the LMKRate metric set. ```APIDOC ## GET apps/*/lmkRateMetricSet ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/{name=apps/*/lmkRateMetricSet}` ### Path Parameters * **name** (string) - Required. The resource name. Format: apps/{app}/lmkRateMetricSet ### Request Body The request body must be empty. ### Response Body If successful, the response body contains an instance of `LmkRateMetricSet`. ### Authorization Scopes Requires the following OAuth scope: * `https://www.googleapis.com/auth/playdeveloperreporting` ``` -------------------------------- ### Fetch Release Filter Options (v1alpha1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves filtering options for releases for a specific app. ```APIDOC ## GET /v1alpha1/{name=apps/*}:fetchReleaseFilterOptions ### Description Describes filtering options for releases. ### Method GET ### Endpoint `/v1alpha1/{name=apps/*}:fetchReleaseFilterOptions` ``` -------------------------------- ### Get Error Count Metric Set (v1alpha1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the error count metric set for an app. ```APIDOC ## GET /v1alpha1/{name=apps/*/errorCountMetricSet} ### Description Describes the properties of the metrics set. ### Method GET ### Endpoint `/v1alpha1/{name=apps/*/errorCountMetricSet}` ``` -------------------------------- ### Get Crash Rate Metric Set (v1alpha1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the crash rate metric set for an app. ```APIDOC ## GET /v1alpha1/{name=apps/*/crashRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1alpha1/{name=apps/*/crashRateMetricSet}` ``` -------------------------------- ### Fetch Release Filter Options Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/apps/fetchReleaseFilterOptions Retrieves a list of tracks, each containing active releases and their version codes, which can be used for filtering. ```APIDOC ## GET apps.fetchReleaseFilterOptions ### Description Fetches filtering options for releases and version codes for a specific app. ### Method GET ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/{name=apps/*}:fetchReleaseFilterOptions` ### Parameters #### Path Parameters - **name** (string) - Required. Name of the resource, i.e. app the filtering options are for. Format: apps/{app} ### Request Body The request body must be empty. ### Response #### Success Response (200) A set of filtering options for releases and version codes specific to an app. - **tracks** (array) - List of tracks to filter releases over. Provides the grouping of version codes under releases and tracks. - **displayName** (string) - Readable identifier of the track. - **type** (string) - The type of the track. - **servingReleases** (array) - Represents all active releases in the track. - **displayName** (string) - Readable identifier of the release. - **versionCodes** (array) - The version codes contained in this release. ### Response Example ```json { "tracks": [ { "displayName": "production", "type": "PRODUCTION", "servingReleases": [ { "displayName": "1.0.0", "versionCodes": [ "1000001", "1000002" ] } ] } ] } ``` ``` -------------------------------- ### Get Error Count Metric Set (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the error count metric set for an app. ```APIDOC ## GET /v1beta1/{name=apps/*/errorCountMetricSet} ### Description Describes the properties of the metrics set. ### Method GET ### Endpoint `/v1beta1/{name=apps/*/errorCountMetricSet}` ``` -------------------------------- ### Query Slow Rendering Rate Metrics (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Queries the slow rendering rate metrics within a metric set for an app. ```APIDOC ## POST /v1beta1/{name=apps/*/slowRenderingRateMetricSet}:query ### Description Queries the metrics in the metric set. ### Method POST ### Endpoint `/v1beta1/{name=apps/*/slowRenderingRateMetricSet}:query` ``` -------------------------------- ### fetchReleaseFilterOptions Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/apps Describes filtering options for releases. ```APIDOC ## fetchReleaseFilterOptions ### Description Describes filtering options for releases. ### Method GET ### Endpoint /v1beta1/apps/{app}:fetchReleaseFilterOptions ### Parameters #### Path Parameters - **app** (string) - Required - Identifier for the app. Format: apps/{app} ### Response #### Success Response (200) - **releaseFilterOptions** (object) - Filtering options for app releases. - **releasePaths** (array) - List of available release paths. - **releasePath** (string) - A specific release path. - **releaseTypes** (array) - List of available release types. - **releaseType** (string) - A specific release type. #### Response Example ```json { "releaseFilterOptions": { "releasePaths": [ "production", "beta", "alpha" ], "releaseTypes": [ "production", "beta", "alpha", "internal" ] } } ``` ``` -------------------------------- ### Get Excessive Wakeup Rate Metric Set (v1alpha1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the excessive wakeup rate metric set for an app. ```APIDOC ## GET /v1alpha1/{name=apps/*/excessiveWakeupRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1alpha1/{name=apps/*/excessiveWakeupRateMetricSet}` ``` -------------------------------- ### Get ANR Rate Metric Set (v1alpha1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the ANR (Application Not Responding) rate metric set for an app. ```APIDOC ## GET /v1alpha1/{name=apps/*/anrRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1alpha1/{name=apps/*/anrRateMetricSet}` ``` -------------------------------- ### Query Slow Rendering Rate Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.slowrenderingrate/query This outlines how to query metrics in a metric set using a `POST` request to a specified URL. The request includes a required `name` parameter and a JSON request body. The body allows specifying `timelineSpec`, `dimensions`, `metrics`, `filter`, `pageSize`, `pageToken`, and `userCohort`. The response includes an array of `rows` containing data and a `nextPageToken` for pagination. This requires authorization via the `playdeveloperreporting` OAuth scope. ```APIDOC ## POST /v1beta1/vitals.slowrenderingrate:query ### Description Queries the slow rendering rate metrics. ### Method POST ### Endpoint /v1beta1/vitals.slowrenderingrate:query ### Parameters #### Request Body - **name** (string) - Required - The resource name of the metric set to query. Example: `websites/12345/metricSets/67890` - **timelineSpec** (object) - Optional - Specifies the time range for the query. - **startDate** (object) - Optional - The start date of the timeline. - **year** (integer) - Optional - Year of the date. - **month** (integer) - Optional - Month of the date. - **day** (integer) - Optional - Day of the date. - **endDate** (object) - Optional - The end date of the timeline. - **year** (integer) - Optional - Year of the date. - **month** (integer) - Optional - Month of the date. - **day** (integer) - Optional - Day of the date. - **period** (string) - Optional - The period for the timeline. Example: `DAILY`, `WEEKLY`, `MONTHLY` - **dimensions** (array) - Optional - A list of dimensions to group the data by. - **dimension** (string) - Optional - The name of the dimension. Example: `countryCode` - **metrics** (array) - Optional - A list of metrics to retrieve. Example: `slowRenderingRate` - **filter** (object) - Optional - Filters to apply to the query. - **fieldName** (string) - Optional - The name of the field to filter on. - **stringValues** (object) - Optional - String values for filtering. - **values** (array) - Optional - List of string values. - **pageSize** (integer) - Optional - The maximum number of rows to return per page. - **pageToken** (string) - Optional - A token to retrieve the next page of data. - **userCohort** (object) - Optional - Specifies the user cohort for the query. - **type** (string) - Optional - The type of user cohort. Example: `ALL_USERS`, `NEW_USERS` ### Request Example ```json { "name": "websites/12345/metricSets/67890", "timelineSpec": { "startDate": { "year": 2023, "month": 1, "day": 1 }, "endDate": { "year": 2023, "month": 1, "day": 31 }, "period": "DAILY" }, "dimensions": [ {"dimension": "countryCode"} ], "metrics": ["slowRenderingRate"], "filter": { "fieldName": "countryCode", "stringValues": { "values": ["US", "CA"] } }, "pageSize": 100, "userCohort": { "type": "ALL_USERS" } } ``` ### Response #### Success Response (200) - **rows** (array) - Returned rows of data. - object (MetricsRow) - **nextPageToken** (string) - Continuation token to fetch the next page of data. #### Response Example ```json { "rows": [ { "dimensionValues": [ { "value": "US" } ], "metricValues": [ { "value": "10.5" } ] } ], "nextPageToken": "CAESABjZGVmZ2hp" } ``` ### Authorization scopes Requires the following OAuth scope: * `https://www.googleapis.com/auth/playdeveloperreporting` ``` -------------------------------- ### Get Excessive Wakeup Rate Metric Set (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the excessive wakeup rate metric set for an app. ```APIDOC ## GET /v1beta1/{name=apps/*/excessiveWakeupRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1beta1/{name=apps/*/excessiveWakeupRateMetricSet}` ``` -------------------------------- ### Query LMK Rate Metrics (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Queries the LMK (Low Memory Killer) rate metrics within a metric set for an app. ```APIDOC ## POST /v1beta1/{name=apps/*/lmkRateMetricSet}:query ### Description Queries the metrics in the metric set. ### Method POST ### Endpoint `/v1beta1/{name=apps/*/lmkRateMetricSet}:query` ``` -------------------------------- ### Get ANR Rate Metric Set (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the ANR (Application Not Responding) rate metric set for an app. ```APIDOC ## GET /v1beta1/{name=apps/*/anrRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1beta1/{name=apps/*/anrRateMetricSet}` ``` -------------------------------- ### Query LMKRate Metrics Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.lmkrate/query Queries the metrics in the metric set. Stay organized with collections. Save and categorize content based on your preferences. ```APIDOC ## POST apps/*/lmkRateMetricSet:query ### Description Queries the metrics in the metric set. ### Method POST ### Endpoint https://playdeveloperreporting.googleapis.com/v1beta1/{name=apps/*/lmkRateMetricSet}:query ### Parameters #### Path Parameters - **name** (string) - Required. The resource name. Format: apps/{app}/lmkRateMetricSet ``` -------------------------------- ### Get LMK Rate Metric Set (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the LMK (Low Memory Killer) rate metric set for an app. ```APIDOC ## GET /v1beta1/{name=apps/*/lmkRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1beta1/{name=apps/*/lmkRateMetricSet}` ``` -------------------------------- ### Query Crash Rate Metrics (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Queries the crash rate metrics within a metric set for an app. ```APIDOC ## POST /v1beta1/{name=apps/*/crashRateMetricSet}:query ### Description Queries the metrics in the metric set. ### Method POST ### Endpoint `/v1beta1/{name=apps/*/crashRateMetricSet}:query` ``` -------------------------------- ### Get Slow Rendering Rate Metric Set Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.slowrenderingrate/get Retrieves a `SlowRenderingRateMetricSet` resource for a given app. This operation requires an OAuth scope for authorization. ```APIDOC ## GET apps/*/slowRenderingRateMetricSet ### Description Retrieves the properties of the metric set for slow rendering rate. ### Method GET ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/{name=apps/*/slowRenderingRateMetricSet}` ### Parameters #### Path Parameters - **name** (string) - Required. The resource name. Format: `apps/{app}/slowRenderingRateMetricSet` ### Request Body The request body must be empty. ### Response #### Success Response (200) Returns an instance of `SlowRenderingRateMetricSet`. ### Authorization scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/playdeveloperreporting` ``` -------------------------------- ### Get ExcessiveWakeupRateMetricSet Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.excessivewakeuprate/get Retrieves the properties of the ExcessiveWakeupRateMetricSet for a given app. This endpoint requires an empty request body and specific OAuth scopes for authorization. ```APIDOC ## GET /v1beta1/{name=apps/*/excessiveWakeupRateMetricSet} ### Description Retrieves the properties of the ExcessiveWakeupRateMetricSet. ### Method GET ### Endpoint `https://playdeveloperreporting.googleapis.com/v1beta1/{name=apps/*/excessiveWakeupRateMetricSet}` ### Path Parameters * **name** (string) - Required. The resource name. Format: `apps/{app}/excessiveWakeupRateMetricSet` ### Request Body The request body must be empty. ### Response #### Success Response (200) Returns an instance of `ExcessiveWakeupRateMetricSet`. ### Authorization Scopes Requires the following OAuth scope: * `https://www.googleapis.com/auth/playdeveloperreporting` ``` -------------------------------- ### StuckBackgroundWakelockRateMetricSet - Query Source: https://developers.google.com/play/developer/reporting/reference/rest/v1beta1/vitals.stuckbackgroundwakelockrate Queries the StuckBackgroundWakelockRateMetricSet resource for a given application, allowing for filtering and aggregation. ```APIDOC ## POST /v1beta1/vitals/stuckBackgroundWakelockRate:query ### Description Queries the `StuckBackgroundWakelockRateMetricSet` resource for a given application, allowing for filtering and aggregation. ### Method POST ### Endpoint `/v1beta1/vitals/stuckBackgroundWakelockRate:query` ### Request Body - **name** (string) - Required - The resource name of the application to query. Format: `apps/{application}` - **timeRange** (TimeRange) - Optional - The time range for which to retrieve data. - **filter** (Filter) - Optional - Filters to apply to the query. - **orderBy** (OrderBy) - Optional - Specifies the order of the results. - **pageSize** (integer) - Optional - The maximum number of results to return. - **pageToken** (string) - Optional - A page token, received from a previous `query` call. ### Request Example ```json { "name": "apps/YOUR_APP_PACKAGE_NAME", "timeRange": { "startTime": { "year": 2023, "month": 1, "day": 1 }, "endTime": { "year": 2023, "month": 1, "day": 31 } }, "filter": { "apiLevel": "30" }, "orderBy": [ { "field": "date", "descending": true } ], "pageSize": 100 } ``` ### Response #### Success Response (200) - **metricSets** (array of StuckBackgroundWakelockRateMetricSet) - The queried metric sets. - **nextPageToken** (string) - A token to retrieve the next page of results. #### Response Example ```json { "metricSets": [ { "metricSet": { "stuckBgWakelockRate": { "rate": "0.1" }, "stuckBgWakelockRate7dUserWeighted": { "rate": "0.2" }, "stuckBgWakelockRate28dUserWeighted": { "rate": "0.3" }, "distinctUsers": "1000" } } ], "nextPageToken": "somePageToken" } ``` ``` -------------------------------- ### Search Apps (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Searches for apps accessible by the authenticated user. ```APIDOC ## GET /v1beta1/apps:search ### Description Searches for Apps accessible by the user. ### Method GET ### Endpoint `/v1beta1/apps:search` ``` -------------------------------- ### Get Stuck Background Wakelock Rate Metric Set (v1beta1) Source: https://developers.google.com/play/developer/reporting/reference/rest Retrieves the properties of the stuck background wakelock rate metric set for an app. ```APIDOC ## GET /v1beta1/{name=apps/*/stuckBackgroundWakelockRateMetricSet} ### Description Describes the properties of the metric set. ### Method GET ### Endpoint `/v1beta1/{name=apps/*/stuckBackgroundWakelockRateMetricSet}` ```