/management/accounts/{accountId}/filters

Lists all filters for an account

{ "items": [ { "accountId": "string", "advancedDetails": { "caseSensitive": true, "extractA": "string", "extractB": "string", "fieldA": "string", "fieldAIndex": 0, "fieldARequired": true, "fieldB": "string", "fieldBIndex": 0, "fieldBRequired": true, "outputConstructor": "string", "outputToField": "string", "outputToFieldIndex": 0, "overrideOutputField": true }, "created": "2019-08-24T14:15:22Z", "excludeDetails": { "caseSensitive": true, "expressionValue": "string", "field": "string", "fieldIndex": 0, "kind": "analytics#filterExpression", "matchType": "string" }, "id": "string", "includeDetails": { "caseSensitive": true, "expressionValue": "string", "field": "string", "fieldIndex": 0, "kind": "analytics#filterExpression", "matchType": "string" }, "kind": "analytics#filter", "lowercaseDetails": { "field": "string", "fieldIndex": 0 }, "name": "string", "parentLink": { "href": "string", "type": "analytics#account" }, "searchAndReplaceDetails": { "caseSensitive": true, "field": "string", "fieldIndex": 0, "replaceString": "string", "searchString": "string" }, "selfLink": "string", "type": "string", "updated": "2019-08-24T14:15:22Z", "uppercaseDetails": { "field": "string", "fieldIndex": 0 } } ], "itemsPerPage": 0, "kind": "analytics#filters", "nextLink": "string", "previousLink": "string", "startIndex": 0, "totalResults": 0, "username": "string" }

Request

Path Params

accountId

string

required

Account ID to retrieve filters for.

Query Params

max-results

integer

optional

The maximum number of filters 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 filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.

items

array[object (Filter) {15}]

optional

A list of filters.

accountId

string

optional

Account ID to which this filter belongs.

advancedDetails

object

optional

Details for the filter of the type ADVANCED.

created

string <date-time>

read-onlyoptional

Time this filter was created.

excludeDetails

object (FilterExpression)

optional

Details for the filter of the type EXCLUDE.

string

optional

Filter ID.

includeDetails

object (FilterExpression)

optional

Details for the filter of the type INCLUDE.

kind

string

read-onlyoptional

Resource type for Analytics filter.

Default:

analytics#filter

lowercaseDetails

object

optional

Details for the filter of the type LOWER.

name

string

optional

Name of this filter.

parentLink

object

optional

Parent link for this filter. Points to the account to which this filter belongs.

searchAndReplaceDetails

object

optional

Details for the filter of the type SEARCH_AND_REPLACE.

selfLink

string

read-onlyoptional

Link for this filter.

type

string

optional

Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.

updated

string <date-time>

read-onlyoptional

Time this filter was last modified.

uppercaseDetails

object

optional

Details for the filter of the type UPPER.

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

nextLink

string

optional

Link to next page for this filter collection.

previousLink

string

optional

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