Method: properties.customMetrics.archive

  • Archives a specific CustomMetric associated with a Google Analytics 4 property.

  • Requires an HTTP POST request to a formatted URL including the property and custom metric IDs.

  • Uses an empty request body and returns an empty response body upon successful archival.

  • Needs authorization with the https://www.googleapis.com/auth/analytics.edit scope.

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