Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.customMetrics.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists CustomMetrics on a property.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/customMetrics
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. Example format: properties/1234
|
Query parameters
| Parameters |
pageSize |
integer
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
A page token, received from a previous customMetrics.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to customMetrics.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for customMetrics.list RPC.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"customMetrics": [
{
object (CustomMetric)
}
],
"nextPageToken": string
} |
| Fields |
customMetrics[] |
object (CustomMetric)
List of CustomMetrics.
|
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 the CustomMetrics defined for a Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eThe API request requires specifying the parent property ID and supports pagination for retrieving large result sets.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of CustomMetrics objects and a token for accessing the next page of results, if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either read-only or edit access to Google Analytics.\u003c/p\u003e\n"]]],["This document details how to list custom metrics for a property using the Google Analytics Admin API. A `GET` HTTP request is sent to a specific URL, including a required `parent` path parameter (e.g., \"properties/1234\"). Optional query parameters `pageSize` (max 200) and `pageToken` are used for pagination. The request body must be empty. A successful response returns a JSON object containing an array of `customMetrics` and an optional `nextPageToken` for retrieving subsequent pages. Authorization requires specific OAuth scopes.\n"],null,["# Method: properties.customMetrics.list\n\n- [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.ListCustomMetricsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists CustomMetrics on a property.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/customMetrics`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------|\n| `parent` | `string` Required. Example format: properties/1234 |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` 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` A page token, received from a previous `customMetrics.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `customMetrics.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for customMetrics.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customMetrics\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#CustomMetric) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `customMetrics[]` | `object (`[CustomMetric](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#CustomMetric)`)` List of CustomMetrics. |\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\n### Authorization 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`"]]
