/management/accounts/{accountId}/filters

POST

management

Create a new filter.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://analytics.googleapis.com/analytics/v3/management/accounts//filters' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
    },
    "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"
    },
    "lowercaseDetails": {
        "field": "string",
        "fieldIndex": 0
    },
    "name": "string",
    "parentLink": {
        "href": "string",
        "type": "analytics#account"
    },
    "searchAndReplaceDetails": {
        "caseSensitive": true,
        "field": "string",
        "fieldIndex": 0,
        "replaceString": "string",
        "searchString": "string"
    },
    "type": "string",
    "uppercaseDetails": {
        "field": "string",
        "fieldIndex": 0
    }
}'

Response Example

{
  "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
  }
}

Request

Path Params

accountId

string

required

Account ID to create filter for.

Body Params application/json

JSON template for an Analytics account filter.

accountId

string

optional

Account ID to which this filter belongs.

advancedDetails

object

optional

Details for the filter of the type ADVANCED.

caseSensitive

boolean

optional

Indicates if the filter expressions are case sensitive.

extractA

string

optional

Expression to extract from field A.

extractB

string

optional

Expression to extract from field B.

fieldA

string

optional

Field A.

fieldAIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

fieldARequired

boolean

optional

Indicates if field A is required to match.

fieldB

string

optional

Field B.

fieldBIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

fieldBRequired

boolean

optional

Indicates if field B is required to match.

outputConstructor

string

optional

Expression used to construct the output value.

outputToField

string

optional

Output field.

outputToFieldIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

overrideOutputField

boolean

optional

Indicates if the existing value of the output field, if any, should be overridden by the output expression.

excludeDetails

object (FilterExpression)

optional

Details for the filter of the type EXCLUDE.

caseSensitive

boolean

optional

Determines if the filter is case sensitive.

expressionValue

string

optional

Filter expression value

field

string

optional

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,

Custom dimension

CUSTOM_DIMENSION (See accompanying field index),

fieldIndex

integer <int32>

optional

The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.

kind

string

optional

Kind value for filter expression

Default:

analytics#filterExpression

matchType

string

optional

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.

string

optional

Filter ID.

includeDetails

object (FilterExpression)

optional

Details for the filter of the type INCLUDE.

lowercaseDetails

object

optional

Details for the filter of the type LOWER.

field

string

optional

Field to use in the filter.

fieldIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

name

string

optional

Name of this filter.

parentLink

object

optional

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

href

string

optional

Link to the account to which this filter belongs.

type

string

optional

Value is "analytics#account".

Default:

analytics#account

searchAndReplaceDetails

object

optional

Details for the filter of the type SEARCH_AND_REPLACE.

caseSensitive

boolean

optional

Determines if the filter is case sensitive.

field

string

optional

Field to use in the filter.

fieldIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

replaceString

string

optional

Term to replace the search term with.

searchString

string

optional

Term to search.

type

string

optional

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

uppercaseDetails

object

optional

Details for the filter of the type UPPER.

field

string

optional

Field to use in the filter.

fieldIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

Examples

Responses

🟢200Successful response

application/json

Body

JSON template for an Analytics account filter.

accountId

string

optional

Account ID to which this filter belongs.

advancedDetails

object

optional

Details for the filter of the type ADVANCED.

caseSensitive

boolean

optional

Indicates if the filter expressions are case sensitive.

extractA

string

optional

Expression to extract from field A.

extractB

string

optional

Expression to extract from field B.

fieldA

string

optional

Field A.

fieldAIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

fieldARequired

boolean

optional

Indicates if field A is required to match.

fieldB

string

optional

Field B.

fieldBIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

fieldBRequired

boolean

optional

Indicates if field B is required to match.

outputConstructor

string

optional

Expression used to construct the output value.

outputToField

string

optional

Output field.

outputToFieldIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

overrideOutputField

boolean

optional

Indicates if the existing value of the output field, if any, should be overridden by the output expression.

created

string <date-time>

read-onlyoptional

Time this filter was created.

excludeDetails

object (FilterExpression)

optional

Details for the filter of the type EXCLUDE.

caseSensitive

boolean

optional

Determines if the filter is case sensitive.

expressionValue

string

optional

Filter expression value

field

string

optional

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,

Custom dimension

CUSTOM_DIMENSION (See accompanying field index),

fieldIndex

integer <int32>

optional

The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.

kind

string

optional

Kind value for filter expression

Default:

analytics#filterExpression

matchType

string

optional

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.

field

string

optional

Field to use in the filter.

fieldIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

name

string

optional

Name of this filter.

parentLink

object

optional

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

href

string

optional

Link to the account to which this filter belongs.

type

string

optional

Value is "analytics#account".

Default:

analytics#account

searchAndReplaceDetails

object

optional

Details for the filter of the type SEARCH_AND_REPLACE.

caseSensitive

boolean

optional

Determines if the filter is case sensitive.

field

string

optional

Field to use in the filter.

fieldIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

replaceString

string

optional

Term to replace the search term with.

searchString

string

optional

Term to search.

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.

field

string

optional

Field to use in the filter.

fieldIndex

integer <int32>

optional

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.

Modified at 2023-08-15 05:39:07

/management/accounts/{accountId}/filters

/management/accounts/{accountId}/filters/{filterId}