Method: properties.customMetrics.archive

  • You can archive a CustomMetric on a property using an HTTP POST request.

  • The request requires a specific format for the name parameter in the URL to identify the CustomMetric to be archived.

  • The request body should be empty for this operation.

  • A successful response will have an empty JSON object as 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/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