/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks

Lists all profile filter links for a profile.

{ "items": [ { "filterRef": { "accountId": "string", "href": "string", "id": "string", "kind": "analytics#filterRef", "name": "string" }, "id": "string", "kind": "analytics#profileFilterLink", "profileRef": { "accountId": "string", "href": "string", "id": "string", "internalWebPropertyId": "string", "kind": "analytics#profileRef", "name": "string", "webPropertyId": "string" }, "rank": 0, "selfLink": "string" } ], "itemsPerPage": 0, "kind": "analytics#profileFilterLinks", "nextLink": "string", "previousLink": "string", "startIndex": 0, "totalResults": 0, "username": "string" }

Request

Path Params

accountId

string

required

Account ID to retrieve profile filter links for.

webPropertyId

string

required

Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.

profileId

string

required

Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.

Query Params

max-results

integer

optional

The maximum number of profile filter links 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 profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.

items

array[object (ProfileFilterLink) {6}]

optional

A list of profile filter links.

filterRef

object (FilterRef)

optional

Filter for this link.

string

optional

Profile filter link ID.

kind

string

read-onlyoptional

Resource type for Analytics filter.

Default:

analytics#profileFilterLink

profileRef

object (ProfileRef)

optional

View (Profile) for this link.

rank

integer <int32>

optional

The rank of this profile filter link relative to the other filters linked to the same profile.
For readonly (i.e., list and get) operations, the rank always starts at 1.
For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.

selfLink

string

read-onlyoptional

Link for this profile filter link.

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 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

kind

string

optional

Collection type.

Default:

analytics#profileFilterLinks

nextLink

string

optional

Link to next page for this profile filter link collection.

previousLink

string

optional

Link to previous page for this profile filter link 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