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

Lists custom metrics to which the user has access.

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

Request

Path Params

accountId

string

required

Account ID for the custom metrics to retrieve.

webPropertyId

string

required

Web property ID for the custom metrics to retrieve.

Query Params

max-results

integer

optional

The maximum number of custom metrics 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 metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.

items

array[object (CustomMetric) {15}]

optional

Collection of custom metrics.

accountId

string

optional

Account ID.

active

boolean

optional

Boolean indicating whether the custom metric is active.

created

string <date-time>

read-onlyoptional

Time the custom metric was created.

string

optional

Custom metric ID.

index

integer <int32>

read-onlyoptional

Index of the custom metric.

kind

string

read-onlyoptional

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

Default:

analytics#customMetric

max_value

string

optional

Max value of custom metric.

min_value

string

optional

Min value of custom metric.

name

string

optional

Name of the custom metric.

parentLink

object

optional

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

scope

string

optional

Scope of the custom metric: HIT or PRODUCT.

selfLink

string

read-onlyoptional

Link for the custom metric

type

string

optional

Data type of custom metric.

updated

string <date-time>

read-onlyoptional

Time the custom metric 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#customMetrics

nextLink

string

optional

Link to next page for this custom metric collection.

previousLink

string

optional

Link to previous page for this custom metric 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