Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.calculatedMetrics.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists CalculatedMetrics on a property.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/calculatedMetrics
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. Example format: properties/1234
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
|
pageToken |
string
Optional. A page token, received from a previous calculatedMetrics.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to calculatedMetrics.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for calculatedMetrics.list RPC.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"calculatedMetrics": [
{
object (CalculatedMetric)
}
],
"nextPageToken": string
} |
| Fields |
calculatedMetrics[] |
object (CalculatedMetric)
List of CalculatedMetrics.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonlyhttps://www.googleapis.com/auth/analytics.edit
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eLists all CalculatedMetrics on a specified Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering using parameters like \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eReturns an array of CalculatedMetrics and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eEmploys gRPC Transcoding for the request URL structure.\u003c/p\u003e\n"]]],["This document details how to list `CalculatedMetrics` for a property using an HTTP GET request to `https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/calculatedMetrics`. The `parent` path parameter is required, specifying the property. Optional query parameters `pageSize` and `pageToken` support pagination. The request body must be empty. The response includes an array of `CalculatedMetrics` and a `nextPageToken` for retrieving further pages. Authorization requires specific OAuth scopes: `analytics.readonly` or `analytics.edit`.\n"],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCalculatedMetricsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists CalculatedMetrics on a property.\n\nHTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/calculatedMetrics`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|----------|----------------------------------------------------|\n| `parent` | `string` Required. Example format: properties/1234 |\n\nQuery parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |\n| `pageToken` | `string` Optional. A page token, received from a previous `calculatedMetrics.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `calculatedMetrics.list` must match the call that provided the page token. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body Response message for calculatedMetrics.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"calculatedMetrics\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics#CalculatedMetric) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `calculatedMetrics[]` | `object (`[CalculatedMetric](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics#CalculatedMetric)`)` List of CalculatedMetrics. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]
