/management/accounts/{accountId}/webproperties

Lists web properties to which the user has access.

{ "items": [ { "accountId": "string", "childLink": { "href": "string", "type": "analytics#profiles" }, "created": "2019-08-24T14:15:22Z", "dataRetentionResetOnNewActivity": true, "dataRetentionTtl": "string", "defaultProfileId": "string", "id": "string", "industryVertical": "string", "internalWebPropertyId": "string", "kind": "analytics#webproperty", "level": "string", "name": "string", "parentLink": { "href": "string", "type": "analytics#account" }, "permissions": { "effective": [ "string" ] }, "profileCount": 0, "selfLink": "string", "starred": true, "updated": "2019-08-24T14:15:22Z", "websiteUrl": "string" } ], "itemsPerPage": 0, "kind": "analytics#webproperties", "nextLink": "string", "previousLink": "string", "startIndex": 0, "totalResults": 0, "username": "string" }

Request

Path Params

accountId

string

required

Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.

Query Params

max-results

integer

optional

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

items

array[object (Webproperty) {19}]

optional

A list of web properties.

accountId

string

optional

Account ID to which this web property belongs.

childLink

object

optional

Child link for this web property. Points to the list of views (profiles) for this web property.

created

string <date-time>

read-onlyoptional

Time this web property was created.

dataRetentionResetOnNewActivity

boolean

optional

Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
Set to false to delete data associated with the user identifier automatically after the rentention period.
This property cannot be set on insert.

dataRetentionTtl

string

optional

The length of time for which user and event data is retained.
This property cannot be set on insert.

defaultProfileId

string <int64>

optional

Default view (profile) ID.

string

optional

Web property ID of the form UA-XXXXX-YY.

industryVertical

string

optional

The industry vertical/category selected for this web property.

internalWebPropertyId

string

read-onlyoptional

Internal ID for this web property.

kind

string

read-onlyoptional

Resource type for Analytics WebProperty.

Default:

analytics#webproperty

level

string

read-onlyoptional

Level for this web property. Possible values are STANDARD or PREMIUM.

name

string

optional

Name of this web property.

parentLink

object

optional

Parent link for this web property. Points to the account to which this web property belongs.

permissions

object

optional

Permissions the user has for this web property.

profileCount

integer <int32>

read-onlyoptional

View (Profile) count for this web property.

selfLink

string

read-onlyoptional

Link for this web property.

starred

boolean

optional

Indicates whether this web property is starred or not.

updated

string <date-time>

read-onlyoptional

Time this web property was last modified.

websiteUrl

string

optional

Website url for this web property.

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#webproperties

nextLink

string

optional

Link to next page for this web property collection.

previousLink

string

optional

Link to previous page for this web property 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