Filters

The Filters collection is a set of Filter resources, each of which describes a filter which can be applied to a View (profile).

For a list of methods for this resource, see the end of this page.

Resource representations

JSON template for an Analytics account filter.

{
  "id": string,
  "kind": "analytics#filter",
  "selfLink": string,
  "accountId": string,
  "name": string,
  "type": string,
  "created": datetime,
  "updated": datetime,
  "parentLink": {
    "type": "analytics#account",
    "href": string
  },
  "includeDetails": {
    "kind": "analytics#filterExpression",
    "field": string,
    "matchType": string,
    "expressionValue": string,
    "caseSensitive": boolean,
    "fieldIndex": integer
  },
  "excludeDetails": {
    "kind": "analytics#filterExpression",
    "field": string,
    "matchType": string,
    "expressionValue": string,
    "caseSensitive": boolean,
    "fieldIndex": integer
  },
  "lowercaseDetails": {
    "field": string,
    "fieldIndex": integer
  },
  "uppercaseDetails": {
    "field": string,
    "fieldIndex": integer
  },
  "searchAndReplaceDetails": {
    "field": string,
    "fieldIndex": integer,
    "searchString": string,
    "replaceString": string,
    "caseSensitive": boolean
  },
  "advancedDetails": {
    "fieldA": string,
    "fieldAIndex": integer,
    "extractA": string,
    "fieldB": string,
    "fieldBIndex": integer,
    "extractB": string,
    "outputToField": string,
    "outputToFieldIndex": integer,
    "outputConstructor": string,
    "fieldARequired": boolean,
    "fieldBRequired": boolean,
    "overrideOutputField": boolean,
    "caseSensitive": boolean
  }
}

Property name	Value	Description	Notes
accountId	string	Account ID to which this filter belongs.
advancedDetails	object	Details for the filter of the type ADVANCED.
advancedDetails.caseSensitive	boolean	Indicates if the filter expressions are case sensitive.	writable
advancedDetails.extractA	string	Expression to extract from field A.	writable
advancedDetails.extractB	string	Expression to extract from field B.	writable
advancedDetails.fieldA	string	Field A.	writable
advancedDetails.fieldAIndex	integer	The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.	writable
advancedDetails.fieldARequired	boolean	Indicates if field A is required to match.	writable
advancedDetails.fieldB	string	Field B.	writable
advancedDetails.fieldBIndex	integer	The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.	writable
advancedDetails.fieldBRequired	boolean	Indicates if field B is required to match.	writable
advancedDetails.outputConstructor	string	Expression used to construct the output value.	writable
advancedDetails.outputToField	string	Output field.	writable
advancedDetails.outputToFieldIndex	integer	The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.	writable
advancedDetails.overrideOutputField	boolean	Indicates if the existing value of the output field, if any, should be overridden by the output expression.	writable
created	datetime	Time this filter was created.
excludeDetails	nested object	Details for the filter of the type EXCLUDE.
excludeDetails.caseSensitive	boolean	Determines if the filter is case sensitive.	writable
excludeDetails.expressionValue	string	Filter expression value	writable
excludeDetails.field	string	Field to filter. Possible values: Content and Traffic PAGE_REQUEST_URI, PAGE_HOSTNAME, PAGE_TITLE, REFERRAL, COST_DATA_URI (Campaign target URL), HIT_TYPE, INTERNAL_SEARCH_TERM, INTERNAL_SEARCH_TYPE, SOURCE_PROPERTY_TRACKING_ID, Campaign or AdGroup CAMPAIGN_SOURCE, CAMPAIGN_MEDIUM, CAMPAIGN_NAME, CAMPAIGN_AD_GROUP, CAMPAIGN_TERM, CAMPAIGN_CONTENT, CAMPAIGN_CODE, CAMPAIGN_REFERRAL_PATH, E-Commerce TRANSACTION_COUNTRY, TRANSACTION_REGION, TRANSACTION_CITY, TRANSACTION_AFFILIATION (Store or order location), ITEM_NAME, ITEM_CODE, ITEM_VARIATION, TRANSACTION_ID, TRANSACTION_CURRENCY_CODE, PRODUCT_ACTION_TYPE, Audience/Users BROWSER, BROWSER_VERSION, BROWSER_SIZE, PLATFORM, PLATFORM_VERSION, LANGUAGE, SCREEN_RESOLUTION, SCREEN_COLORS, JAVA_ENABLED (Boolean Field), FLASH_VERSION, GEO_SPEED (Connection speed), VISITOR_TYPE, GEO_ORGANIZATION (ISP organization), GEO_DOMAIN, GEO_IP_ADDRESS, GEO_IP_VERSION, Location GEO_COUNTRY, GEO_REGION, GEO_CITY, Event EVENT_CATEGORY, EVENT_ACTION, EVENT_LABEL, Other CUSTOM_FIELD_1, CUSTOM_FIELD_2, USER_DEFINED_VALUE, Application APP_ID, APP_INSTALLER_ID, APP_NAME, APP_VERSION, SCREEN, IS_APP (Boolean Field), IS_FATAL_EXCEPTION (Boolean Field), EXCEPTION_DESCRIPTION, Mobile device IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), DEVICE_CATEGORY, MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), MOBILE_HAS_NFC_SUPPORT (Boolean Field), MOBILE_HAS_CELLULAR_RADIO (Boolean Field), MOBILE_HAS_WIFI_SUPPORT (Boolean Field), MOBILE_BRAND_NAME, MOBILE_MODEL_NAME, MOBILE_MARKETING_NAME, MOBILE_POINTING_METHOD, Social SOCIAL_NETWORK, SOCIAL_ACTION, SOCIAL_ACTION_TARGET,	writable
excludeDetails.fieldIndex	integer	The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.	writable
excludeDetails.kind	string	Kind value for filter expression
excludeDetails.matchType	string	Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.	writable
id	string	Filter ID.
includeDetails	nested object	Details for the filter of the type INCLUDE.
includeDetails.caseSensitive	boolean	Determines if the filter is case sensitive.	writable
includeDetails.expressionValue	string	Filter expression value	writable
includeDetails.field	string	Field to filter. Possible values: Content and Traffic PAGE_REQUEST_URI, PAGE_HOSTNAME, PAGE_TITLE, REFERRAL, COST_DATA_URI (Campaign target URL), HIT_TYPE, INTERNAL_SEARCH_TERM, INTERNAL_SEARCH_TYPE, SOURCE_PROPERTY_TRACKING_ID, Campaign or AdGroup CAMPAIGN_SOURCE, CAMPAIGN_MEDIUM, CAMPAIGN_NAME, CAMPAIGN_AD_GROUP, CAMPAIGN_TERM, CAMPAIGN_CONTENT, CAMPAIGN_CODE, CAMPAIGN_REFERRAL_PATH, E-Commerce TRANSACTION_COUNTRY, TRANSACTION_REGION, TRANSACTION_CITY, TRANSACTION_AFFILIATION (Store or order location), ITEM_NAME, ITEM_CODE, ITEM_VARIATION, TRANSACTION_ID, TRANSACTION_CURRENCY_CODE, PRODUCT_ACTION_TYPE, Audience/Users BROWSER, BROWSER_VERSION, BROWSER_SIZE, PLATFORM, PLATFORM_VERSION, LANGUAGE, SCREEN_RESOLUTION, SCREEN_COLORS, JAVA_ENABLED (Boolean Field), FLASH_VERSION, GEO_SPEED (Connection speed), VISITOR_TYPE, GEO_ORGANIZATION (ISP organization), GEO_DOMAIN, GEO_IP_ADDRESS, GEO_IP_VERSION, Location GEO_COUNTRY, GEO_REGION, GEO_CITY, Event EVENT_CATEGORY, EVENT_ACTION, EVENT_LABEL, Other CUSTOM_FIELD_1, CUSTOM_FIELD_2, USER_DEFINED_VALUE, Application APP_ID, APP_INSTALLER_ID, APP_NAME, APP_VERSION, SCREEN, IS_APP (Boolean Field), IS_FATAL_EXCEPTION (Boolean Field), EXCEPTION_DESCRIPTION, Mobile device IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), DEVICE_CATEGORY, MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), MOBILE_HAS_NFC_SUPPORT (Boolean Field), MOBILE_HAS_CELLULAR_RADIO (Boolean Field), MOBILE_HAS_WIFI_SUPPORT (Boolean Field), MOBILE_BRAND_NAME, MOBILE_MODEL_NAME, MOBILE_MARKETING_NAME, MOBILE_POINTING_METHOD, Social SOCIAL_NETWORK, SOCIAL_ACTION, SOCIAL_ACTION_TARGET,	writable
includeDetails.fieldIndex	integer	The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.	writable
includeDetails.kind	string	Kind value for filter expression
includeDetails.matchType	string	Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.	writable
kind	string	Resource type for Analytics filter.
lowercaseDetails	object	Details for the filter of the type LOWER.
lowercaseDetails.field	string	Field to use in the filter.	writable
lowercaseDetails.fieldIndex	integer	The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.	writable
name	string	Name of this filter.	writable
parentLink	object	Parent link for this filter. Points to the account to which this filter belongs.
parentLink.href	string	Link to the account to which this filter belongs.
parentLink.type	string	Value is "analytics#account".
searchAndReplaceDetails	object	Details for the filter of the type SEARCH_AND_REPLACE.
searchAndReplaceDetails.caseSensitive	boolean	Determines if the filter is case sensitive.	writable
searchAndReplaceDetails.field	string	Field to use in the filter.	writable
searchAndReplaceDetails.fieldIndex	integer	The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.	writable
searchAndReplaceDetails.replaceString	string	Term to replace the search term with.	writable
searchAndReplaceDetails.searchString	string	Term to search.	writable
selfLink	string	Link for this filter.
type	string	Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.	writable
updated	datetime	Time this filter was last modified.
uppercaseDetails	object	Details for the filter of the type UPPER.
uppercaseDetails.field	string	Field to use in the filter.	writable
uppercaseDetails.fieldIndex	integer	The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.	writable

Methods

delete

Delete a filter.

get

Returns a filters to which the user has access.

insert

Create a new filter.

list

Lists all filters for an account

patch

Updates an existing filter. This method supports patch semantics.

update

Updates an existing filter.