Method: properties.customDimensions.archive

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

  • The URL includes path parameters, specifically the required name of the CustomDimension to archive.

  • The request body must be empty, and a successful response will also have an empty body.

  • Authorization requires the https://www.googleapis.com/auth/analytics.edit OAuth scope.

Archives a CustomDimension on a property.

HTTP request

POST https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/customDimensions/*}:archive

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/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