Method: properties.customMetrics.archive

  • CustomMetrics can be archived on a property using a POST request to the specified URL.

  • The path parameter name is required and identifies the CustomMetric to be archived.

  • The request body for archiving a CustomMetric must be empty.

  • A successful archive operation returns an empty JSON object in the response body.

  • Archiving a CustomMetric requires the https://www.googleapis.com/auth/analytics.edit authorization scope.

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