Take our developer survey. We want your feedback so we can learn how to improve Google Analytics, and make it an even better tool for you.

Custom Dimensions

For a list of methods for this resource, see the end of this page.

Resource representations

JSON template for Analytics Custom Dimension.

{
  "kind": "analytics#customDimension",
  "id": string,
  "accountId": string,
  "webPropertyId": string,
  "name": string,
  "index": integer,
  "scope": string,
  "active": boolean,
  "created": datetime,
  "updated": datetime,
  "selfLink": string,
  "parentLink": {
    "type": "analytics#webproperty",
    "href": string
  }
}
Property name Value Description Notes
accountId string Account ID.
active boolean Boolean indicating whether the custom dimension is active.
created datetime Time the custom dimension was created.
id string Custom dimension ID.
index integer Index of the custom dimension.
kind string Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
name string Name of the custom dimension.
parentLink.href string Link to the property to which the custom dimension belongs.
parentLink.type string Type of the parent link. Set to "analytics#webproperty".
scope string Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
updated datetime Time the custom dimension was last modified.
webPropertyId string Property ID.

Methods

get
Get a custom dimension to which the user has access.
insert
Create a new custom dimension.
list
Lists custom dimensions to which the user has access.
patch
Updates an existing custom dimension. This method supports patch semantics.
update
Updates an existing custom dimension.