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/v1alpha/{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 specified CustomMetric associated with a Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eRequires an HTTP POST request to a specific endpoint with the CustomMetric's resource name.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and upon success, the response body will also be empty.\u003c/p\u003e\n"],["\u003cp\u003eTo authorize, you need the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["The core action is archiving a CustomMetric, specified by its `name` via a `POST` request to a URL using gRPC Transcoding. The `name`, a string representing the CustomMetric's identifier, is required as a path parameter. The request body must be empty. A successful response returns an empty JSON object. Authorization for this action requires the `https://www.googleapis.com/auth/analytics.edit` OAuth scope. The action uses `POST` HTTP request.\n"],null,["- [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\nHTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/customMetrics/*}:archive`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678 |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body is an empty JSON object.\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
