Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.customMetrics.archive
Stay organized with collections
Save and categorize content based on your preferences.
Archives a CustomMetric on a property.
HTTP request
POST https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/customMetrics/*}:archive
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678
|
Request body
The request body must be empty.
Response body
If successful, the response body is an empty JSON object.
Authorization scopes
Requires the following OAuth scope:
https://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-01-14 UTC.
[null,null,["Last updated 2025-01-14 UTC."],[[["\u003cp\u003eArchives a specific CustomMetric associated with a Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eRequires an HTTP POST request to a formatted URL including the property and custom metric IDs.\u003c/p\u003e\n"],["\u003cp\u003eUses an empty request body and returns an empty response body upon successful archival.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document outlines how to archive a CustomMetric within a property using a POST request. The core action is initiated via a specific URL (`POST https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/customMetrics/*}:archive`), where the `name` parameter, representing the CustomMetric's identifier, is required within the path. The request body must be empty and the response upon successful completion is an empty JSON object. This operation mandates the `https://www.googleapis.com/auth/analytics.edit` authorization scope.\n"],null,["# Method: properties.customMetrics.archive\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nArchives a CustomMetric on a property.\n\n### HTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/customMetrics/*}:archive`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678 |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
