/management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions

Lists custom dimensions to which the user has access.

{ "items": [ { "accountId": "string", "active": true, "created": "2019-08-24T14:15:22Z", "id": "string", "index": 0, "kind": "analytics#customDimension", "name": "string", "parentLink": { "href": "string", "type": "analytics#webproperty" }, "scope": "string", "selfLink": "string", "updated": "2019-08-24T14:15:22Z", "webPropertyId": "string" } ], "itemsPerPage": 0, "kind": "analytics#customDimensions", "nextLink": "string", "previousLink": "string", "startIndex": 0, "totalResults": 0, "username": "string" }

Request

Path Params

accountId

string

required

Account ID for the custom dimensions to retrieve.

webPropertyId

string

required

Web property ID for the custom dimensions to retrieve.

Query Params

max-results

integer

optional

The maximum number of custom dimensions to include in this response.

start-index

integer

optional

An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Responses

🟢200Successful response

application/json

Body

A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.

items

array[object (CustomDimension) {12}]

optional

Collection of custom dimensions.

accountId

string

optional

Account ID.

active

boolean

optional

Boolean indicating whether the custom dimension is active.

created

string <date-time>

read-onlyoptional

Time the custom dimension was created.

string

optional

Custom dimension ID.

index

integer <int32>

read-onlyoptional

Index of the custom dimension.

kind

string

read-onlyoptional

Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.

Default:

analytics#customDimension

name

string

optional

Name of the custom dimension.

parentLink

object

optional

Parent link for the custom dimension. Points to the property to which the custom dimension belongs.

scope

string

optional

Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

selfLink

string

read-onlyoptional

Link for the custom dimension

updated

string <date-time>

read-onlyoptional

Time the custom dimension was last modified.

webPropertyId

string

optional

Property ID.

itemsPerPage

integer <int32>

optional

The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

kind

string

optional

Collection type.

Default:

analytics#customDimensions

nextLink

string

optional

Link to next page for this custom dimension collection.

previousLink

string

optional

Link to previous page for this custom dimension collection.

startIndex

integer <int32>

optional

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.

totalResults

integer <int32>

optional

The total number of results for the query, regardless of the number of results in the response.

username

string

optional

Email ID of the authenticated user