API Dimensions & Metrics

These dimensions and metrics are supported in Analytics Data API funnel reports.

Dimensions

The following dimensions can be requested in funnel reports for any property. Specify the "API Name" in a Dimension resource's name field.

API Name UI Name Available in Segments Description
achievementId Achievement ID Yes The achievement ID in a game for an event. Populated by the event parameter achievement_id.
adFormat Ad format Yes Describes the way ads looked and where they were located. Typical formats include Interstitial, Banner, Rewarded, and Native advanced.
adSourceName Ad source No The source network that served the ad. Typical sources include AdMob Network, Liftoff, Facebook Audience Network, and Mediated house ads.
adUnitName Ad unit No The name you chose to describe this Ad unit. Ad units are containers you place in your apps to show ads to users.
appVersion App version Yes The app's versionName (Android) or short bundle version (iOS).
audienceId Audience ID No The numeric identifier of an Audience. Users are reported in the audiences to which they belonged during the report's date range. Current user behavior does not affect historical audience membership in reports.
audienceName Audience name No The given name of an Audience. Users are reported in the audiences to which they belonged during the report's date range. Current user behavior does not affect historical audience membership in reports.
audienceResourceName Audience resource name No The resource name of this audience. Resource names contain both collection & resource identifiers to uniquely identify a resource; to learn more, see Resource names.
brandingInterest Interests No Interests demonstrated by users who are higher in the shopping funnel. Users can be counted in multiple interest categories. For example, Shoppers, Lifestyles & Hobbies/Pet Lovers, or Travel/Travel Buffs/Beachbound Travelers.
browser Browser Yes The browsers used to view your website.
campaignId Campaign ID Yes The identifier of the marketing campaign. Present only for key events. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
campaignName Campaign Yes The name of the marketing campaign. Present only for key events. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
character Character Yes The player character in a game for an event. Populated by the event parameter character.
city City Yes The city from which the user activity originated.
cityId City ID Yes The geographic ID of the city from which the user activity originated, derived from their IP address.
cm360AccountId CM360 account ID Yes The CM360 Account ID that led to the key event. Identifies the CM360 Account.
cm360AccountName CM360 account name Yes The CM360 Account Name that led to the key event. A CM360 account consists of advertisers, sites, campaigns, and user profiles.
cm360AdvertiserId CM360 advertiser ID Yes The CM360 Advertiser ID that led to the key event. A CM360 Advertiser contains a group of campaigns, creative assets, and other settings.
cm360AdvertiserName CM360 advertiser name Yes The CM360 Advertiser Name that led to the key event. A CM360 Advertiser contains a group of campaigns, creative assets, and other settings.
cm360CampaignId CM360 campaign ID Yes The CM360 Campaign ID that led to the key event. A CM360 campaign can be configured to specify when your ads run, what landing pages are used, and other properties.
cm360CampaignName CM360 campaign name Yes The CM360 Campaign Name that led to the key event. A CM360 campaign can be configured to specify when your ads run, what landing pages are used, and other properties.
cm360CreativeFormat CM360 creative format Yes The CM360 Creative Format that led to the key event. CM360 creative formats are also referred to as creative types.
cm360CreativeId CM360 creative ID Yes The CM360 Creative ID that led to the key event. Identifies a CM360 creative.
cm360CreativeName CM360 creative name Yes The CM360 Creative Name that led to the key event. The name given to a CM360 creative.
cm360CreativeType CM360 creative type Yes The CM360 Creative Type that led to the key event. A category of CM360 creatives like 'Display' or 'Tracking'. To learn more, see manage creatives
cm360CreativeTypeId CM360 creative type ID Yes The CM360 Creative Type ID that led to the key event. Identifies a CM360 creative type.
cm360CreativeVersion CM360 creative version Yes The CM360 Creative Version that led to the key event. The version number helps you keep track of multiple versions of your creative in your reports. If you upload a new asset to an existing creative, the version number is increased by one.
cm360Medium CM360 medium Yes The CM360 Medium that led to the key event. The CM360 medium is also referred to as the placement cost structure.
cm360PlacementCostStructure CM360 placement cost structure Yes The CM360 Placement Cost Structure that led to the key event. Placement cost structures regulate how media cost will be calculated. For example 'CPM'.
cm360PlacementId CM360 placement ID Yes The CM360 Placement ID that led to the key event. Identifies a CM360 placement. A placement is the part of a website where your ad appears.
cm360PlacementName CM360 placement name Yes The CM360 Placement Name that led to the key event. The given name for a CM360 placement. A placement is the part of a website where your ad appears.
cm360RenderingId CM360 rendering ID Yes The CM360 Rendering ID that led to the key event. Identifies a CM360 creative.
cm360SiteId CM360 site ID Yes The CM360 Site ID that led to the key event. Identifies a CM360 site.
cm360SiteName CM360 site name Yes The CM360 Site Name that led to the key event. The CM360 Site name from which the ad space was purchased.
cm360Source CM360 source Yes The CM360 Source that led to the key event. The CM360 source is also referred to as the site name.
cm360SourceMedium CM360 source / medium Yes The CM360 Source Medium that led to the key event. A combination of the source and medium.
cohort Cohort No The cohort's name in the request. A cohort is a set of users who started using your website or app in any consecutive group of days. If a cohort name is not specified in the request, cohorts are named by their zero based index such as cohort_0 and cohort_1.
cohortNthDay Daily cohort No Day offset relative to the firstSessionDate for the users in the cohort. For example, if a cohort is selected with the start and end date of 2020-03-01, then for the date 2020-03-02, cohortNthDay will be 0001.
cohortNthMonth Monthly cohort No Month offset relative to the firstSessionDate for the users in the cohort. Month boundaries align with calendar month boundaries. For example, if a cohort is selected with the start and end date in March 2020, then for any date in April 2020, cohortNthMonth will be 0001.
cohortNthWeek Weekly cohort No Week offset relative to the firstSessionDate for the users in the cohort. Weeks start on Sunday and end on Saturday. For example, if a cohort is selected with the start and end date in the range 2020-11-08 to 2020-11-14, then for the dates in the range 2020-11-15 to 2020-11-21, cohortNthWeek will be 0001.
contentGroup Content group Yes A category that applies to items of published content. Populated by the event parameter content_group.
contentId Content ID Yes The identifier of the selected content. Populated by the event parameter content_id.
contentType Content type Yes The category of the selected content. Populated by the event parameter content_type.
continent Continent Yes The continent from which the user activity originated. For example, Americas or Asia.
continentId Continent ID No The geographic ID of the continent from which the user activity originated, derived from their IP address.
country Country Yes The country from which the user activity originated.
countryId Country ID Yes The geographic ID of the country from which the user activity originated, derived from their IP address. Formatted according to ISO 3166-1 alpha-2 standard.
currencyCode Currency No The local currency code (based on ISO 4217 standard) of the eCommerce event. For example, USD or GBP. Currency is specified in tagging by the currency parameter. Businesses that transact in more than one currency can specify a local currency code when sending eCommerce events to Analytics, and this dimension shows those currencies. To Learn more, See Currency reference.
date Date Yes The date of the event, formatted as YYYYMMDD.
dateHour Date + hour (YYYYMMDDHH) Yes The combined values of date and hour formatted as YYYYMMDDHH.
dateHourMinute Date hour and minute No The combined values of date, hour, and minute formatted as YYYYMMDDHHMM.
day Day Yes The day of the month, a two-digit number from 01 to 31.
dayOfWeek Day of week Yes The integer day of the week. It returns values in the range 0 to 6 with Sunday as the first day of the week.
dayOfWeekName Day of week name No The day of the week in English. This dimension has values such as Sunday or Monday.
defaultChannelGroup Default channel group Yes The key event's default channel group is based primarily on source and medium. An enumeration which includes Direct, Organic Search, Paid Social, Organic Social, Email, Affiliates, Referral, Paid Search, Video, and Display.
deviceCategory Device category Yes The type of device: Desktop, Tablet, or Mobile.
deviceModel Device model Yes The mobile device model (example: iPhone 10,6).
dv360AdvertiserId DV360 advertiser ID Yes The DV360 Advertiser ID that led to the key event. Identifies the DV360 advertiser.
dv360AdvertiserName DV360 advertiser name Yes The DV360 Advertiser Name that led to the key event. DV360 advertisers represent real-life businesses that run advertising campaigns.
dv360CampaignId DV360 campaign ID Yes The DV360 Campaign ID that led to the key event. Identifies the DV360 campaign.
dv360CampaignName DV360 campaign name Yes The DV360 Campaign Name that led to the key event. DV360 campaigns group together related insertion orders with a common business goal.
dv360CreativeFormat DV360 creative format Yes The DV360 Creative Format that led to the key event. Also referred to as the creative type. For example, expandable, video, or native.
dv360CreativeId DV360 creative ID Yes The DV360 Creative ID that led to the key event. Identifies the DV360 creative.
dv360CreativeName DV360 creative name Yes The DV360 Creative Name that led to the key event. The name given to a DV360 creative.
dv360ExchangeId DV360 exchange ID Yes The DV360 Exchange ID that led to the key event. Identifies the DV360 exchange.
dv360ExchangeName DV360 exchange name Yes The DV360 Exchange Name that led to the key event. The DV360 ad exchange involved in the ad click. To learn more, see managing exchanges.
dv360InsertionOrderId DV360 insertion order ID Yes The DV360 Insertion Order ID that led to the key event. Identifies the DV360 insertion order.
dv360InsertionOrderName DV360 insertion order name Yes The DV360 Insertion Order Name that led to the key event. A DV360 insertion order contains a set of line items that are related to the same advertising campaign.
dv360LineItemId DV360 line item ID Yes The DV360 Line Item ID that led to the key event. Identifies the DV360 line item.
dv360LineItemName DV360 line item name Yes The DV360 Line Item Name that led to the key event. A DV360 line item bids on impressions and serves creatives to inventory sources.
dv360Medium DV360 medium Yes The DV360 Medium that led to the key event. The billable outcome of the insertion order. For example, cpm.
dv360PartnerId DV360 partner ID Yes The DV360 Partner ID that led to the key event. Identifies the DV360 partner.
dv360PartnerName DV360 partner name Yes The DV360 Partner Name that led to the key event. DV360 partners represent agencies, trading desks, or large individual advertisers.
dv360Source DV360 source Yes The DV360 Source that led to the key event. The DV360 site name where your ad was displayed.
dv360SourceMedium DV360 source / medium Yes The DV360 Source Medium that led to the key event. A combination of the source and medium.
eventName Event name Yes The name of the event.
fileExtension File extension Yes The extension of the downloaded file (for example, pdf or txt). Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter file_extension.
fileName File name Yes The page path of the downloaded file (for example, /menus/dinner-menu.pdf). Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter file_name.
firstSessionDate First session date Yes The date the user's first session occurred, formatted as YYYYMMDD.
firstUserCampaignId First user campaign ID Yes Identifier of the marketing campaign that first acquired the user. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
firstUserCampaignName First user campaign Yes Name of the marketing campaign that first acquired the user. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
firstUserCm360AccountId First user CM360 account ID Yes The CM360 Account ID that originally acquired the user. Identifies the CM360 account.
firstUserCm360AccountName First user CM360 account name Yes The CM360 Account Name that originally acquired the user. A CM360 account consists of advertisers, sites, campaigns, and user profiles.
firstUserCm360AdvertiserId First user CM360 advertiser ID Yes The CM360 Advertiser ID that originally acquired the user. Identifies the CM360 advertiser.
firstUserCm360AdvertiserName First user CM360 advertiser name Yes The CM360 Advertiser Name that originally acquired the user. A CM360 Advertiser contains a group of campaigns, creative assets, and other settings.
firstUserCm360CampaignId First user CM360 campaign ID Yes The CM360 Campaign ID that originally acquired the user. Identifies the CM360 campaign.
firstUserCm360CampaignName First user CM360 campaign name Yes The CM360 Campaign Name that originally acquired the user. A CM360 campaign can be configured to specify when your ads run, what landing pages are used, and other properties.
firstUserCm360CreativeFormat First user CM360 creative format Yes The CM360 Creative Format that originally acquired the user. CM360 creative formats are also referred to as creative types.
firstUserCm360CreativeId First user CM360 creative ID Yes The CM360 Creative ID that originally acquired the user. Identifies a CM360 creative.
firstUserCm360CreativeName First user CM360 creative name Yes The CM360 Creative Name that originally acquired the user. The name given to a CM360 creative.
firstUserCm360CreativeType First user CM360 creative type Yes The CM360 Creative Type that originally acquired the user. A category of CM360 creatives like 'Display' or 'Tracking'. To learn more, see manage creatives
firstUserCm360CreativeTypeId First user CM360 creative type ID Yes The CM360 Creative Type ID that originally acquired the user. Identifies a CM360 creative type.
firstUserCm360CreativeVersion First user CM360 creative version Yes The CM360 Creative Version that originally acquired the user. The version number helps you keep track of multiple versions of your creative in your reports. If you upload a new asset to an existing creative, the version number is increased by one.
firstUserCm360Medium First user CM360 medium Yes The CM360 Medium that originally acquired the user. The CM360 medium is also referred to as the placement cost structure.
firstUserCm360PlacementCostStructure First user CM360 placement cost structure Yes The CM360 Placement Cost Structure that originally acquired the user. Placement cost structures regulate how media cost will be calculated. For example 'CPM'.
firstUserCm360PlacementId First user CM360 placement ID Yes The CM360 Placement ID that originally acquired the user. Identifies a CM360 placement. A placement is the part of a website where your ad appears.
firstUserCm360PlacementName First user CM360 placement name Yes The CM360 Placement Name that originally acquired the user. The given name for a CM360 placement. A placement is the part of a website where your ad appears.
firstUserCm360RenderingId First user CM360 rendering ID Yes The CM360 Rendering ID that originally acquired the user. Identifies a CM360 creative.
firstUserCm360SiteId First user CM360 site ID Yes The CM360 Site ID that originally acquired the user. Identifies a CM360 site.
firstUserCm360SiteName First user CM360 site name Yes The CM360 Site Name that originally acquired the user. The CM360 Site name from which the ad space was purchased.
firstUserCm360Source First user CM360 source Yes The CM360 Source that originally acquired the user. The CM360 source is also referred to as the site name.
firstUserCm360SourceMedium First user CM360 source / medium Yes The CM360 Source Medium that originally acquired the user. A combination of the source and medium.
firstUserDefaultChannelGroup First user default channel group Yes The default channel group that first acquired the user. Default channel group is based primarily on source and medium. An enumeration which includes Direct, Organic Search, Paid Social, Organic Social, Email, Affiliates, Referral, Paid Search, Video, and Display.
firstUserDv360AdvertiserId First user DV360 advertiser ID Yes The DV360 Advertiser ID that originally acquired the user. Identifies the DV360 advertiser.
firstUserDv360AdvertiserName First user DV360 advertiser name Yes The DV360 Advertiser Name that originally acquired the user. DV360 advertisers represent real-life businesses that run advertising campaigns.
firstUserDv360CampaignId First user DV360 campaign ID Yes The DV360 Campaign ID that originally acquired the user. Identifies the DV360 campaign.
firstUserDv360CampaignName First user DV360 campaign name Yes The DV360 Campaign Name that originally acquired the user. DV360 campaigns group together related insertion orders with a common business goal.
firstUserDv360CreativeFormat First user DV360 creative format Yes The DV360 Creative Format that originally acquired the user. Also referred to as the creative type. For example, expandable, video, or native.
firstUserDv360CreativeId First user DV360 creative ID Yes The DV360 Creative ID that originally acquired the user. Identifies the DV360 creative.
firstUserDv360CreativeName First user DV360 creative name Yes The DV360 Creative Name that originally acquired the user. The name given to a DV360 creative.
firstUserDv360ExchangeId First user DV360 exchange ID Yes The DV360 Exchange ID that originally acquired the user. Identifies the DV360 exchange.
firstUserDv360ExchangeName First user DV360 exchange name Yes The DV360 Exchange Name that originally acquired the user. The DV360 ad exchange involved in the ad click. To learn more, see managing exchanges.
firstUserDv360InsertionOrderId First user DV360 insertion order ID Yes The DV360 Insertion Order ID that originally acquired the user. Identifies the DV360 insertion order.
firstUserDv360InsertionOrderName First user DV360 insertion order name Yes The DV360 Insertion Order Name that originally acquired the user. A DV360 insertion order contains a set of line items that are related to the same advertising campaign.
firstUserDv360LineItemId First user DV360 line item ID Yes The DV360 Line Item ID that originally acquired the user. Identifies the DV360 line item.
firstUserDv360LineItemName First user DV360 line item name Yes The DV360 Line Item Name that originally acquired the user. A DV360 line item bids on impressions and serves creatives to inventory sources.
firstUserDv360Medium First user DV360 medium Yes The DV360 Medium that originally acquired the user. The billable outcome of the insertion order. For example, cpm.
firstUserDv360PartnerId First user DV360 partner ID Yes The DV360 Partner ID that originally acquired the user. Identifies the DV360 partner.
firstUserDv360PartnerName First user DV360 partner name Yes The DV360 Partner Name that originally acquired the user. DV360 partners represent agencies, trading desks, or large individual advertisers.
firstUserDv360Source First user DV360 source Yes The DV360 Source that originally acquired the user. The DV360 site name where your ad was displayed.
firstUserDv360SourceMedium First user DV360 source / medium Yes The DV360 Source Medium that originally acquired the user. A combination of the source and medium.
firstUserGoogleAdsAccountName First user Google Ads account name Yes The Account name from Google Ads that first acquired the user.
firstUserGoogleAdsAdGroupId First user Google Ads ad group ID Yes The Ad Group Id in Google Ads that first acquired the user.
firstUserGoogleAdsAdGroupName First user Google Ads ad group name Yes The Ad Group Name in Google Ads that first acquired the user.
firstUserGoogleAdsAdNetworkType First user Google Ads ad network type Yes The advertising network that first acquired the user. An enumeration which includes Google search, Search partners, Google Display Network, Youtube Search, Youtube Videos, Cross-network, Social, and (universal campaign).
firstUserGoogleAdsCampaignId First user Google Ads campaign ID No Identifier of the Google Ads marketing campaign that first acquired the user.
firstUserGoogleAdsCampaignName First user Google Ads campaign No Name of the Google Ads marketing campaign that first acquired the user.
firstUserGoogleAdsCampaignType First user Google Ads campaign type No The campaign type of the Google Ads campaign that first acquired the user. Campaign types determine where customers see your ads and the settings and options available to you in Google Ads. Campaign type is an enumeration that includes: Search, Display, Shopping, Video, Demand Gen, App, Smart, Hotel, Local, and Performance Max. To learn more, see Choose the right campaign type.
firstUserGoogleAdsCreativeId First user Google Ads creative ID No The ID of the Google Ads creative that first acquired the user. Creative IDs identify individual ads.
firstUserGoogleAdsCustomerId First user Google Ads customer ID Yes The Customer ID from Google Ads that first acquired the user. Customer IDs in Google Ads uniquely identify Google Ads accounts.
firstUserGoogleAdsKeyword First user Google Ads keyword text Yes First user Google Ads keyword text
firstUserGoogleAdsQuery First user Google Ads query Yes The search query that first acquired the user.
firstUserManualAdContent First user manual ad content Yes The ad content that first acquired the user. Populated by the utm_content parameter.
firstUserManualCampaignId First user manual campaign ID Yes The manual Campaign ID that originally acquired the user. Identifies the manual campaign. Populated by utm_id URL parameter.
firstUserManualCampaignName First user manual campaign name Yes The manual Campaign Name that originally acquired the user. The name of the manual campaign. Populated by utm_campaign URL parameter. To learn more, see Collect campaign data with custom URLs.
firstUserManualCreativeFormat First user manual creative format Yes The manual Creative Format that originally acquired the user. Identifies the creative format used in the ad. Populated by utm_creative_format URL parameter.
firstUserManualMarketingTactic First user manual marketing tactic No The manual Marketing Tactic that originally acquired the user. The targeting criteria applied to a campaign. For example, remarketing or prospecting. Populated by utm_marketing_tactic URL parameter.
firstUserManualMedium First user manual medium Yes The manual Medium that originally acquired the user. The marketing medium used in the referral. For example, cpc. Populated by utm_medium URL parameter.
firstUserManualSource First user manual source Yes The manual Source that originally acquired the user. The referrer. Populated by utm_source URL parameter.
firstUserManualSourceMedium First user manual source / medium Yes The manual Source Medium that originally acquired the user. A combination of the source and medium.
firstUserManualSourcePlatform First user manual source platform Yes The manual Source Platform that originally acquired the user. The platform responsible for directing traffic to a given Analytics property. Populated by utm_source_platform URL parameter.
firstUserManualTerm First user manual term Yes The term that first acquired the user. Populated by the utm_term parameter.
firstUserMedium First user medium Yes The medium that first acquired the user to your website or app.
firstUserPrimaryChannelGroup First user primary channel group No The primary channel group that originally acquired a user. Primary channel groups are the channel groups used in standard reports in Google Analytics and serve as an active record of your property's data in alignment with channel grouping over time. To learn more, see Custom channel groups.
firstUserSa360AdGroupId First user SA360 ad group ID Yes The SA360 Ad Group ID that originally acquired the user. Identifies the SA360 ad group.
firstUserSa360AdGroupName First user SA360 ad group name Yes The SA360 Ad Group Name that originally acquired the user. SA360 Ad groups contain ads and keywords that relate to each other.
firstUserSa360CampaignId First user SA360 campaign ID Yes The SA360 Campaign ID that originally acquired the user. Identifies the SA360 campaign.
firstUserSa360CampaignName First user SA360 campaign Yes The SA360 Campaign Name that originally acquired the user. A SA360 campaign lets you organize your ads and define a goal for your advertising.
firstUserSa360CreativeFormat First user SA360 creative format No The SA360 Creative Format that originally acquired the user. The creative format is the specific layout or design of the advertisement used in a campaign.
firstUserSa360EngineAccountId First user SA360 engine account ID Yes The SA360 Engine Account ID that originally acquired the user. Identifies the SA360 engine account.
firstUserSa360EngineAccountName First user SA360 engine account name Yes The SA360 Engine Account Name that originally acquired the user. A SA360 engine account contains campaigns, ad groups, and other items from an advertising account. To learn more, see SA360 engine account.
firstUserSa360EngineAccountType First user SA360 engine account type Yes The SA360 Engine Account Type that originally acquired the user. The type of engine used by the search engine account.
firstUserSa360KeywordText First user SA360 keyword text Yes The SA360 Keyword Text that originally acquired the user. The keywords that matched the search query.
firstUserSa360ManagerAccountId First user SA360 manager account ID Yes The SA360 Manager Account ID that originally acquired the user. Identifies the SA360 manager account.
firstUserSa360ManagerAccountName First user SA360 manager account name Yes The SA360 Manager Account Name that originally acquired the user. The top level of the Search Ads 360 account hierarchy and is used for administration and reporting across the lower-level sub-manager and client accounts.
firstUserSa360Medium First user SA360 medium Yes The SA360 Medium that originally acquired the user. The payment mode used in ad buying. For example, cpc.
firstUserSa360Query First user SA360 query Yes The SA360 Query that originally acquired the user. The search query typed by the user.
firstUserSa360Source First user SA360 source Yes The SA360 Source that originally acquired the user. The search query happened on this site.
firstUserSa360SourceMedium First user SA360 source / medium Yes The SA360 Source Medium that originally acquired the user. A combination of the source and medium.
firstUserSource First user source Yes The source that first acquired the user to your website or app.
firstUserSourceMedium First user source / medium Yes The combined values of the dimensions firstUserSource and firstUserMedium.
firstUserSourcePlatform First user source platform Yes The source platform that first acquired the user. Don't depend on this field returning Manual for traffic that uses UTMs; this field will update from returning Manual to returning (not set) for an upcoming feature launch.
fullPageUrl Full page URL No The hostname, page path, and query string for web pages visited; for example, the fullPageUrl portion of https://www.example.com/store/contact-us?query_string=true is www.example.com/store/contact-us?query_string=true.
funnelStepName Step No The descriptive name assigned to the funnel step. For example, specifying name = Purchase in the third funnel step in the request will produce 3. Purchase for this funnelStepName dimension in the funnel report response.
funnelStepNewVsContinuing New vs continuing No A user is continuing in funnel steps if they were present in the prior funnel step. Otherwise, that user is new. This dimension is only meaningful for open funnels and returns two values: new and continuing.
funnelStepNextAction Funnel next action No The next action is the next dimension value attained by the user after completing the current step & inclusive of completing the next step. For example if the requested next action dimension is eventName, then this dimension returns the name of the next event after attaining the ith step; this next action is exclusive of the event that attained the ith step and inclusive of the event that attained the i+1`th step.
googleAdsAccountName Google Ads account name Yes The Account name from Google Ads for the campaign that led to the key event. Corresponds to customer.descriptive_name in the Google Ads API.
googleAdsAdGroupId Google Ads ad group ID No The Google Ads ad group ID attributed to the key event.
googleAdsAdGroupName Google Ads ad group name No The ad group name attributed to the key event.
googleAdsAdNetworkType Google Ads ad network type Yes The advertising network type of the key event. An enumeration which includes Google search, Search partners, Google Display Network, Youtube Search, Youtube Videos, Cross-network, Social, and (universal campaign).
googleAdsCampaignId Google Ads campaign ID No The campaign ID for the Google Ads campaign attributed to the key event.
googleAdsCampaignName Google Ads campaign No The campaign name for the Google Ads campaign attributed to the key event.
googleAdsCampaignType Google Ads campaign type No The campaign type for the Google Ads campaign attributed to the key event. Campaign types determine where customers see your ads and the settings and options available to you in Google Ads. Campaign type is an enumeration that includes: Search, Display, Shopping, Video, Demand Gen, App, Smart, Hotel, Local, and Performance Max. To learn more, see Choose the right campaign type.
googleAdsCreativeId Google Ads creative ID No The ID of the Google Ads creative attributed to the key event. Creative IDs identify individual ads.
googleAdsCustomerId Google Ads customer ID Yes The Customer ID from Google Ads for the campaign that led to key event. Customer IDs in Google Ads uniquely identify Google Ads accounts.
googleAdsKeyword Google Ads keyword text No The matched keyword that led to the key event. Keywords are words or phrases describing your product or service that you choose to get your ad in front of the right customers. To learn more about Keywords, see Keywords: Definition.
googleAdsQuery Google Ads query No The search query that led to the key event.
groupId Group ID Yes The player group ID in a game for an event. Populated by the event parameter group_id.
hostName Hostname Yes Includes the subdomain and domain names of a URL; for example, the Host Name of www.example.com/contact.html is www.example.com.
hour Hour Yes The two-digit hour of the day that the event was logged. This dimension ranges from 0-23 and is reported in your property's timezone.
isKeyEvent Is key event Yes The string true if the event is a key event. Marking an event as a key event affects reports from time of creation. It doesn't change historic data. You can mark any event as key in Google Analytics, and some events (such as first_open or purchase) are marked as key events by default.
isoWeek ISO week of the year No ISO week number, where each week starts on Monday. For details, see http://en.wikipedia.org/wiki/ISO_week_date. Example values include 01, 02, & 53.
isoYear ISO year No The ISO year of the event. For details, see http://en.wikipedia.org/wiki/ISO_week_date. Example values include 2022 & 2023.
isoYearIsoWeek ISO week of ISO year No The combined values of isoWeek and isoYear. Example values include 201652 & 201701.
itemAffiliation Item affiliation Yes The name or code of the affiliate (partner/vendor; if any) associated with an individual item. Populated by the affiliation item parameter.
itemBrand Item brand Yes Brand name of the item.
itemCategory Item category Yes The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Apparel is the item category.
itemCategory2 Item category 2 Yes The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Mens is the item category 2.
itemCategory3 Item category 3 Yes The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Summer is the item category 3.
itemCategory4 Item category 4 Yes The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Shirts is the item category 4.
itemCategory5 Item category 5 Yes The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, T-shirts is the item category 5.
itemId Item ID Yes The ID of the item.
itemListId Item list ID Yes The ID of the item list.
itemListName Item list name Yes The name of the item list.
itemListPosition Item list position Yes The position of an item in a list. For example, a product you sell in a list. This dimension is populated in tagging by the index parameter in the items array.
itemLocationID Item location ID Yes The physical location associated with the item. For example, the physical store location. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. This field is populated in tagging by the location_id parameter in the items array.
itemName Item name Yes The name of the item.
itemPromotionCreativeName Item promotion creative name Yes The name of the item-promotion creative.
itemPromotionCreativeSlot Item promotion creative slot Yes The name of the promotional creative slot associated with the item. This dimension can be specified in tagging by the creative_slot parameter at the event or item level. If the parameter is specified at both the event & item level, the item-level parameter is used.
itemPromotionId Item promotion ID Yes The ID of the item promotion.
itemPromotionName Item promotion name Yes The name of the promotion for the item.
itemVariant Item variant Yes The specific variation of a product. For example, XS, S, M, or L for size; or Red, Blue, Green, or Black for color. Populated by the item_variant parameter.
landingPage Landing page No The page path associated with the first pageview in a session.
landingPagePlusQueryString Landing page + query string Yes The page path + query string associated with the first pageview in a session.
language Language Yes The language setting of the user's browser or device. For example, English.
languageCode Language code Yes The language setting (ISO 639) of the user's browser or device. For example, en-us.
level Level Yes The player's level in a game. Populated by the event parameter level.
linkClasses Link classes Yes The HTML class attribute for an outbound link. For example if a user clicks a link <a class="center" href="www.youtube.com">, this dimension will return center. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter link_classes.
linkDomain Link domain Yes The destination domain of the outbound link. For example if a user clicks a link <a href="www.youtube.com">, this dimension will return youtube.com. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter link_domain.
linkId Link ID Yes The HTML ID attribute for an outbound link or file download. For example if a user clicks a link <a id="socialLinks" href="www.youtube.com">, this dimension will return socialLinks. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter link_id.
linkText Link text Yes The link text of the file download. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter link_text.
linkUrl Link URL Yes The full URL for an outbound link or file download. For example if a user clicks a link <a href="https://www.youtube.com/results?search_query=analytics">, this dimension will return https://www.youtube.com/results?search_query=analytics. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter link_url.
manualAdContent Manual ad content Yes The ad content attributed to the key event. Populated by the utm_content parameter.
manualCampaignId Manual campaign ID Yes The manual Campaign ID that led to the key event. Identifies the manual campaign. Populated by utm_id URL parameter.
manualCampaignName Manual campaign name Yes The manual Campaign Name that led to the key event. The name of the manual campaign. Populated by utm_campaign URL parameter. To learn more, see Collect campaign data with custom URLs.
manualCreativeFormat Manual creative format Yes The manual Creative Format that led to the key event. Identifies the creative format used in the ad. Populated by utm_creative_format URL parameter.
manualMarketingTactic Manual marketing tactic No The manual Marketing Tactic that led to the key event. The targeting criteria applied to a campaign. For example, remarketing or prospecting. Populated by utm_marketing_tactic URL parameter.
manualMedium Manual medium Yes The manual Medium that led to the key event. The marketing medium used in the referral. For example, cpc. Populated by utm_medium URL parameter.
manualSource Manual source Yes The manual Source that led to the key event. The referrer. Populated by utm_source URL parameter.
manualSourceMedium Manual source / medium Yes The manual Source Medium that led to the key event. A combination of the source and medium.
manualSourcePlatform Manual source platform Yes The manual Source Platform that led to the key event. The platform responsible for directing traffic to a given Analytics property. Populated by utm_source_platform URL parameter.
manualTerm Manual term Yes The term attributed to the key event. Populated by the utm_term parameter.
medium Medium Yes The medium attributed to the key event.
method Method Yes The method by which an event was triggered. Populated by the event parameter method.
minute Minute Yes The two-digit minute of the hour that the event was logged. This dimension ranges from 0-59 and is reported in your property's timezone.
mobileDeviceBranding Device brand Yes Manufacturer or branded name (examples: Samsung, HTC, Verizon, T-Mobile).
mobileDeviceMarketingName Device Yes The branded device name (examples: Galaxy S10 or P30 Pro).
mobileDeviceModel Mobile model Yes The mobile device model name (examples: iPhone X or SM-G950F).
month Month Yes The month of the event, a two digit integer from 01 to 12.
newVsReturning New / returning Yes New users have 0 previous sessions, and returning users have 1 or more previous sessions. This dimension returns two values: new or returning.
nthDay Nth day No The number of days since the start of the date range.
nthHour Nth hour No The number of hours since the start of the date range. The starting hour is 0000.
nthMinute Nth minute No The number of minutes since the start of the date range. The starting minute is 0000.
nthMonth Nth month No The number of months since the start of a date range. The starting month is 0000.
nthWeek Nth week No A number representing the number of weeks since the start of a date range.
nthYear Nth year No The number of years since the start of the date range. The starting year is 0000.
operatingSystem Operating system Yes The operating systems used by visitors to your app or website. Includes desktop and mobile operating systems such as Windows and Android.
operatingSystemVersion OS version Yes The operating system versions used by visitors to your website or app. For example, Android 10's version is 10, and iOS 13.5.1's version is 13.5.1.
operatingSystemWithVersion Operating system with version Yes The operating system and version. For example, Android 10 or Windows 7.
orderCoupon Order coupon Yes Code for the order-level coupon.
outbound Outbound Yes Returns true if the link led to a site that is not a part of the property's domain. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter outbound.
pageLocation Page location Yes The protocol, hostname, page path, and query string for web pages visited; for example, the pageLocation portion of https://www.example.com/store/contact-us?query_string=true is https://www.example.com/store/contact-us?query_string=true. Populated by the event parameter page_location.
pagePath Page path No The portion of the URL between the hostname and query string for web pages visited; for example, the pagePath portion of https://www.example.com/store/contact-us?query_string=true is /store/contact-us.
pagePathPlusQueryString Page path + query string Yes The portion of the URL following the hostname for web pages visited; for example, the pagePathPlusQueryString portion of https://www.example.com/store/contact-us?query_string=true is /store/contact-us?query_string=true.
pageReferrer Page referrer Yes The full referring URL including the hostname and path. This referring URL is the user's previous URL and can be this website's domain or other domains. Populated by the event parameter page_referrer.
pageTitle Page title Yes The web page titles used on your site.
percentScrolled Percent scrolled Yes The percentage down the page that the user has scrolled (for example, 90). Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter percent_scrolled.
platform Platform Yes The platform on which your app or website ran; for example, web, iOS, or Android. To determine a stream's type in a report, use both platform and streamId.
platformDeviceCategory Platform / device category Yes The platform and type of device on which your website or mobile app ran. (example: Android / mobile)
primaryChannelGroup Primary channel group No The primary channel group attributed to the key event. Primary channel groups are the channel groups used in standard reports in Google Analytics and serve as an active record of your property's data in alignment with channel grouping over time. To learn more, see Custom channel groups.
region Region Yes The geographic region from which the user activity originated, derived from their IP address.
sa360AdGroupId SA360 ad group ID Yes The SA360 Ad Group ID that led to the key event. Identifies the SA360 ad group.
sa360AdGroupName SA360 ad group name Yes The SA360 Ad Group Name that led to the key event. SA360 Ad groups contain ads and keywords that relate to each other.
sa360CampaignId SA360 campaign ID Yes The SA360 Campaign ID that led to the key event. Identifies the SA360 campaign.
sa360CampaignName SA360 campaign Yes The SA360 Campaign Name that led to the key event. A SA360 campaign lets you organize your ads and define a goal for your advertising.
sa360CreativeFormat SA360 creative format No The SA360 Creative Format that led to the key event. The creative format is the specific layout or design of the advertisement used in a campaign.
sa360EngineAccountId SA360 engine account ID Yes The SA360 Engine Account ID that led to the key event. Identifies the SA360 engine account.
sa360EngineAccountName SA360 engine account name Yes The SA360 Engine Account Name that led to the key event. A SA360 engine account contains campaigns, ad groups, and other items from an advertising account. To learn more, see SA360 engine account.
sa360EngineAccountType SA360 engine account type Yes The SA360 Engine Account Type that led to the key event. The type of engine used by the search engine account.
sa360KeywordText SA360 keyword text Yes The SA360 Keyword Text that led to the key event. The keywords that matched the search query.
sa360ManagerAccountId SA360 manager account ID Yes The SA360 Manager Account ID that led to the key event. Identifies the SA360 manager account.
sa360ManagerAccountName SA360 manager account name Yes The SA360 Manager Account Name that led to the key event. The top level of the Search Ads 360 account hierarchy and is used for administration and reporting across the lower-level sub-manager and client accounts.
sa360Medium SA360 medium Yes The SA360 Medium that led to the key event. The payment mode used in ad buying. For example, cpc.
sa360Query SA360 query Yes The SA360 Query that led to the key event. The search query typed by the user.
sa360Source SA360 source Yes The SA360 Source that led to the key event. The search query happened on this site.
sa360SourceMedium SA360 source / medium Yes The SA360 Source Medium that led to the key event. A combination of the source and medium.
screenResolution Screen resolution Yes The screen resolution of the user's monitor. For example, 1920x1080.
searchTerm Search term Yes The term searched by the user. For example if the user visits /some-page.html?q=some-term, this dimension returns some-term. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter search_term.
segment Segment No A segment is a subset of your Analytics data. For example, of your entire set of users, one segment might be users from a particular country or city. To learn more, see Segment builder. The segment dimension returns the name assigned to the segment in the request with a 1-based prefix (i.e. if the first segment is named Paid Traffic in the request, then this segment will be 1. Paid Traffic in the response). If segments names are not specified in the request, segments are named by 1-based names such as 1. Segment ans 2. Segment).
sessionCampaignId Session campaign ID Yes The marketing campaign ID for a session. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
sessionCampaignName Session campaign Yes The marketing campaign name for a session. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
sessionCm360AccountId Session CM360 account ID Yes The CM360 Account ID that led to the session. Identifies the CM360 account.
sessionCm360AccountName Session CM360 account name Yes The CM360 Account Name that led to the session. A CM360 account consists of advertisers, sites, campaigns, and user profiles.
sessionCm360AdvertiserId Session CM360 advertiser ID Yes The CM360 Advertiser ID that led to the session. Identifies the CM360 advertiser.
sessionCm360AdvertiserName Session CM360 advertiser name Yes The CM360 Advertiser Name that led to the session. A CM360 Advertiser contains a group of campaigns, creative assets, and other settings.
sessionCm360CampaignId Session CM360 campaign ID Yes The CM360 Campaign ID that led to the session. Identifies the CM360 campaign.
sessionCm360CampaignName Session CM360 campaign name Yes The CM360 Campaign Name that led to the session. A CM360 campaign can be configured to specify when your ads run, what landing pages are used, and other properties.
sessionCm360CreativeFormat Session CM360 creative format Yes The CM360 Creative Format that led to the session. CM360 creative formats are also referred to as creative types.
sessionCm360CreativeId Session CM360 creative ID Yes The CM360 Creative ID that led to the session. Identifies a CM360 creative.
sessionCm360CreativeName Session CM360 creative name Yes The CM360 Creative Name that led to the session. The name given to a CM360 creative.
sessionCm360CreativeType Session CM360 creative type Yes The CM360 Creative Type that led to the session. A category of CM360 creatives like 'Display' or 'Tracking'. To learn more, see manage creatives
sessionCm360CreativeTypeId Session CM360 creative type ID Yes The CM360 Creative Type ID that led to the session. Identifies a CM360 creative type.
sessionCm360CreativeVersion Session CM360 creative version Yes The CM360 Creative Version that led to the session. The version number helps you keep track of multiple versions of your creative in your reports. If you upload a new asset to an existing creative, the version number is increased by one.
sessionCm360Medium Session CM360 medium Yes The CM360 Medium that led to the session. The CM360 medium is also referred to as the placement cost structure.
sessionCm360PlacementCostStructure Session CM360 placement cost structure Yes The CM360 Placement Cost Structure that led to the session. Placement cost structures regulate how media cost will be calculated. For example 'CPM'.
sessionCm360PlacementId Session CM360 placement ID Yes The CM360 Placement ID that led to the session. Identifies a CM360 placement. A placement is the part of a website where your ad appears.
sessionCm360PlacementName Session CM360 placement name Yes The CM360 Placement Name that led to the session. The given name for a CM360 placement. A placement is the part of a website where your ad appears.
sessionCm360RenderingId Session CM360 rendering ID Yes The CM360 Rendering ID that led to the session. Identifies a CM360 creative.
sessionCm360SiteId Session CM360 site ID Yes The CM360 Site ID that led to the session. Identifies a CM360 site.
sessionCm360SiteName Session CM360 site name Yes The CM360 Site Name that led to the session. The CM360 Site name from which the ad space was purchased.
sessionCm360Source Session CM360 source Yes The CM360 Source that led to the session. The CM360 source is also referred to as the site name.
sessionCm360SourceMedium Session CM360 source / medium Yes The CM360 Source Medium that led to the session. A combination of the source and medium.
sessionDefaultChannelGroup Session default channel group Yes The session's default channel group is based primarily on source and medium. An enumeration which includes Direct, Organic Search, Paid Social, Organic Social, Email, Affiliates, Referral, Paid Search, Video, and Display.
sessionDv360AdvertiserId Session DV360 advertiser ID Yes The DV360 Advertiser ID that led to the session. Identifies the DV360 advertiser.
sessionDv360AdvertiserName Session DV360 advertiser name Yes The DV360 Advertiser Name that led to the session. DV360 advertisers represent real-life businesses that run advertising campaigns.
sessionDv360CampaignId Session DV360 campaign ID Yes The DV360 Campaign ID that led to the session. Identifies the DV360 campaign.
sessionDv360CampaignName Session DV360 campaign name Yes The DV360 Campaign Name that led to the session. DV360 campaigns group together related insertion orders with a common business goal.
sessionDv360CreativeFormat Session DV360 creative format Yes The DV360 Creative Format that led to the session. Also referred to as the creative type. For example, expandable, video, or native.
sessionDv360CreativeId Session DV360 creative ID Yes The DV360 Creative ID that led to the session. Identifies the DV360 creative.
sessionDv360CreativeName Session DV360 creative name Yes The DV360 Creative Name that led to the session. The name given to a DV360 creative.
sessionDv360ExchangeId Session DV360 exchange ID Yes The DV360 Exchange ID that led to the session. Identifies the DV360 exchange.
sessionDv360ExchangeName Session DV360 exchange name Yes The DV360 Exchange Name that led to the session. The DV360 ad exchange involved in the ad click. To learn more, see managing exchanges.
sessionDv360InsertionOrderId Session DV360 insertion order ID Yes The DV360 Insertion Order ID that led to the session. Identifies the DV360 insertion order.
sessionDv360InsertionOrderName Session DV360 insertion order name Yes The DV360 Insertion Order Name that led to the session. A DV360 insertion order contains a set of line items that are related to the same advertising campaign.
sessionDv360LineItemId Session DV360 line item ID Yes The DV360 Line Item ID that led to the session. Identifies the DV360 line item.
sessionDv360LineItemName Session DV360 line item name Yes The DV360 Line Item Name that led to the session. A DV360 line item bids on impressions and serves creatives to inventory sources.
sessionDv360Medium Session DV360 medium Yes The DV360 Medium that led to the session. The billable outcome of the insertion order. For example, cpm.
sessionDv360PartnerId Session DV360 partner ID Yes The DV360 Partner ID that led to the session. Identifies the DV360 partner.
sessionDv360PartnerName Session DV360 partner name Yes The DV360 Partner Name that led to the session. DV360 partners represent agencies, trading desks, or large individual advertisers.
sessionDv360Source Session DV360 source Yes The DV360 Source that led to the session. The DV360 site name where your ad was displayed.
sessionDv360SourceMedium Session DV360 source / medium Yes The DV360 Source Medium that led to the session. A combination of the source and medium.
sessionGoogleAdsAccountName Session Google Ads account name Yes The Account name from Google Ads that led to the session. Corresponds to customer.descriptive_name in the Google Ads API.
sessionGoogleAdsAdGroupId Session Google Ads ad group ID Yes The Ad Group Id in Google Ads for a session.
sessionGoogleAdsAdGroupName Session Google Ads ad group name Yes The Ad Group Name in Google Ads for a session.
sessionGoogleAdsAdNetworkType Session Google Ads ad network type Yes The advertising network that led to the session. An enumeration which includes Google search, Search partners, Google Display Network, Youtube Search, Youtube Videos, Cross-network, Social, and (universal campaign).
sessionGoogleAdsCampaignId Session Google Ads campaign ID No The Campaign ID for the Google Ads Campaign that led to this session.
sessionGoogleAdsCampaignName Session Google Ads campaign No The Campaign name for the Google Ads Campaign that led to this session.
sessionGoogleAdsCampaignType Session Google Ads campaign type No The campaign type for the Google Ads campaign that led to this session. Campaign types determine where customers see your ads and the settings and options available to you in Google Ads. Campaign type is an enumeration that includes: Search, Display, Shopping, Video, Demand Gen, App, Smart, Hotel, Local, and Performance Max. To learn more, see Choose the right campaign type.
sessionGoogleAdsCreativeId Session Google Ads creative ID No The ID of the Google Ads creative that led to a session on your website or app. Creative IDs identify individual ads.
sessionGoogleAdsCustomerId Session Google Ads customer ID Yes The Customer ID from Google Ads that led to the session. Customer IDs in Google Ads uniquely identify Google Ads accounts.
sessionGoogleAdsKeyword Session Google Ads keyword text Yes The matched keyword that led to the session. Keywords are words or phrases describing your product or service that you choose to get your ad in front of the right customers. To learn more about Keywords, see Keywords: Definition.
sessionGoogleAdsQuery Session Google Ads query Yes The search query that led to the session.
sessionManualAdContent Session manual ad content Yes The ad content that led to a session. Populated by the utm_content parameter.
sessionManualCampaignId Session manual campaign ID Yes The manual Campaign ID that led to the session. Identifies the manual campaign. Populated by utm_id URL parameter.
sessionManualCampaignName Session manual campaign name Yes The manual Campaign Name that led to the session. The name of the manual campaign. Populated by utm_campaign URL parameter. To learn more, see Collect campaign data with custom URLs.
sessionManualCreativeFormat Session manual creative format Yes The manual Creative Format that led to the session. Identifies the creative format used in the ad. Populated by utm_creative_format URL parameter.
sessionManualMarketingTactic Session manual marketing tactic No The manual Marketing Tactic that led to the session. The targeting criteria applied to a campaign. For example, remarketing or prospecting. Populated by utm_marketing_tactic URL parameter.
sessionManualMedium Session manual medium Yes The manual Medium that led to the session. The marketing medium used in the referral. For example, cpc. Populated by utm_medium URL parameter.
sessionManualSource Session manual source Yes The manual Source that led to the session. The referrer. Populated by utm_source URL parameter.
sessionManualSourceMedium Session manual source / medium Yes The manual Source Medium that led to the session. A combination of the source and medium.
sessionManualSourcePlatform Session manual source platform Yes The manual Source Platform that led to the session. The platform responsible for directing traffic to a given Analytics property. Populated by utm_source_platform URL parameter.
sessionManualTerm Session manual term Yes The term that led to a session. Populated by the utm_term parameter.
sessionMedium Session medium Yes The medium that initiated a session on your website or app.
sessionPrimaryChannelGroup Session primary channel group No The primary channel group that led to the session. Primary channel groups are the channel groups used in standard reports in Google Analytics and serve as an active record of your property's data in alignment with channel grouping over time. To learn more, see Custom channel groups.
sessionSa360AdGroupId Session SA360 ad group ID Yes The SA360 Ad Group ID that led to the session. Identifies the SA360 ad group.
sessionSa360AdGroupName Session SA360 ad group name Yes The SA360 Ad Group Name that led to the session. SA360 Ad groups contain ads and keywords that relate to each other.
sessionSa360CampaignId Session SA360 campaign ID Yes The SA360 Campaign ID that led to the session. Identifies the SA360 campaign.
sessionSa360CampaignName Session SA360 campaign Yes The SA360 Campaign Name that led to the session. A SA360 campaign lets you organize your ads and define a goal for your advertising.
sessionSa360CreativeFormat Session SA360 creative format No The SA360 Creative Format that led to the session. The creative format is the specific layout or design of the advertisement used in a campaign.
sessionSa360EngineAccountId Session SA360 engine account ID Yes The SA360 Engine Account ID that led to the session. Identifies the SA360 engine account.
sessionSa360EngineAccountName Session SA360 engine account name Yes The SA360 Engine Account Name that led to the session. A SA360 engine account contains campaigns, ad groups, and other items from an advertising account. To learn more, see SA360 engine account.
sessionSa360EngineAccountType Session SA360 engine account type Yes The SA360 Engine Account Type that led to the session. The type of engine used by the search engine account. For example, google ads, bing, or baidu.
sessionSa360Keyword Session SA360 keyword text Yes The SA360 Keyword Text that led to the session. The keywords that matched the search query.
sessionSa360ManagerAccountId Session SA360 manager account ID Yes The SA360 Manager Account ID that led to the session. Identifies the SA360 manager account.
sessionSa360ManagerAccountName Session SA360 manager account name Yes The SA360 Manager Account Name that led to the session. The top level of the Search Ads 360 account hierarchy and is used for administration and reporting across the lower-level sub-manager and client accounts.
sessionSa360Medium Session SA360 medium Yes The SA360 Medium that led to the session. The payment mode used in ad buying. For example, cpc.
sessionSa360Query Session SA360 query Yes The SA360 Query that led to the session. The search query typed by the user.
sessionSa360Source Session SA360 source Yes The SA360 Source that led to the session. The search query happened on this site.
sessionSa360SourceMedium Session SA360 source / medium Yes The SA360 Source Medium that led to the session. A combination of the source and medium.
sessionSource Session source Yes The source that initiated a session on your website or app.
sessionSourceMedium Session source / medium Yes The combined values of the dimensions sessionSource and sessionMedium.
sessionSourcePlatform Session source platform Yes The source platform of the session's campaign. Don't depend on this field returning Manual for traffic that uses UTMs; this field will update from returning Manual to returning (not set) for an upcoming feature launch.
shippingTier Shipping tier No The shipping tier selected for delivery of the purchased item. For example, Ground, Air, or Next-day. Populated by the shipping_tier event parameter.
signedInWithUserId Signed in with user ID Yes The string yes if the user signed in with the User-ID feature. To learn more about User-ID, see Measure activity across platforms with User-ID.
source Source Yes The source attributed to the key event.
sourceMedium Source / medium Yes The combined values of the dimensions source and medium.
sourcePlatform Source platform Yes The source platform of the key event's campaign. Don't depend on this field returning Manual for traffic that uses UTMs; this field will update from returning Manual to returning (not set) for an upcoming feature launch.
streamId Stream ID Yes The numeric data stream identifier for your app or website.
streamName Stream name Yes The data stream name for your app or website.
testDataFilterId Test data filter ID No The numeric identifier of a data filter in testing state. You use data filters to include or exclude event data from your reports based on event-parameter values. To learn more, see Data filters.
testDataFilterName Test data filter name No The name of data filters in testing state. You use data filters to include or exclude event data from your reports based on event-parameter values. To learn more, see Data filters.
transactionId Transaction ID Yes The ID of the ecommerce transaction.
unifiedPagePathScreen Page path and screen class Yes The page path (web) or screen class (app) on which the event was logged.
unifiedPageScreen Page path + query string and screen class Yes The page path and query string (web) or screen class (app) on which the event was logged.
unifiedScreenClass Page title and screen class Yes The page title (web) or screen class (app) on which the event was logged.
unifiedScreenName Page title and screen name Yes The page title (web) or screen name (app) on which the event was logged.
userAgeBracket Age Yes User age brackets.
userGender Gender Yes User gender.
videoProvider Video provider Yes The source of the video (for example, youtube). Automatically populated for embedded videos if Enhanced Measurement is enabled. Populated by the event parameter video_provider.
videoTitle Video title Yes The title of the video. Automatically populated for embedded videos if Enhanced Measurement is enabled. Populated by the event parameter video_title.
videoUrl Video URL Yes The URL of the video. Automatically populated for embedded videos if Enhanced Measurement is enabled. Populated by the event parameter video_url.
virtualCurrencyName Virtual currency name Yes The name of a virtual currency with which the user is interacting. Such as spending or purchasing gems in a game. Populated by the virtual_currency_name event parameter.
visible Visible Yes Returns true if the content is visible. Automatically populated for embedded videos if Enhanced Measurement is enabled. Populated by the event parameter visible.
week Week Yes The week of the event, a two-digit number from 01 to 53. Each week starts on Sunday. January 1st is always in week 01. The first and last week of the year have fewer than 7 days in most years. Weeks other than the first and the last week of the year always have 7 days. For years where January 1st is a Sunday, the first week of that year and the last week of the prior year have 7 days.
year Year Yes The four-digit year of the event. For example, 2020 or 2024.
yearMonth Year month No The combined values of year and month. Example values include 202212 or 202301.
yearWeek Year week No The combined values of year and week. Example values include 202253 or 202301.

Custom Dimensions

The Data API can create reports on Event and User scoped Custom Dimensions. See Event-scoped custom dimensions and metrics reporting and Custom user properties to learn more about custom dimensions. Custom dimensions are specified in an API report request by the dimension's parameter name and scope. For example, include "customEvent:achievement_id" in a Data API request to create a report for the Event-scoped Custom Dimension with parameter name "achievement_id". This API request will fail if the property has not registered this Event-scoped Custom Dimension.

If an Event-scoped Custom Dimension was registered before October 2020, the dimension must be specified in an API request with its event name. For example, include "customEvent:achievement_id\[level_up\]" for the Event-scoped Custom Dimension with parameter name "achievement_id" and event name "level_up". In October 2020, Analytics replaced Custom-parameter reporting with Event-scoped custom dimensions and metrics reporting.

The following are the general syntax for Custom Dimensions. You can query the Metadata API method to list all Custom Dimensions for a Property; here is an example of using the Metadata API method.

Generic API Name Available in Segments Description
customEvent:parameter_name Yes Event-scoped Custom Dimension for parameter_name
customEvent:parameter_name[event_name] Yes Event-scoped Custom Dimension for parameter_name if registered before October 2020
customUser:parameter_name Yes User-scoped Custom Dimension for parameter_name

Custom Channel Groups

The Data API can create reports on Custom Channel Groups. To learn more about Custom channel groups, see Custom channel groups in Google Analytics. Custom Channel Groups are specified in an API report request by the dimension's scope and channel group ID. For example, include "sessionCustomChannelGroup:9432931" in a Data API request to create a report for the Session-scoped Custom Channel with an ID of 9432931. This API request will fail if the property does not have a custom channel with this ID.

The following are the general syntax for Custom Channel Groups. You can query the Metadata API method to list all Custom Channel Groups for a Property.

Generic API Name Description
sessionCustomChannelGroup:custom_channel_id The custom channel that lead to this session.
firstUserCustomChannelGroup:custom_channel_id The custom channel that first acquired this user.
customChannelGroup:custom_channel_id The custom channel that led to the key event.

Metrics

The following metrics can be in funnel reports for any property.

API Name UI Name Description
activeUsers Active users The number of distinct users who visited your site or app.
funnelStepAbandonmentRate Abandonment rate The percentage of users that abandon the funnel at this step. This metric is returned as a fraction; for example, 0.412 means 41.2% of users abandoned the funnel at this step.
funnelStepAbandonments Abandonments The absolute number of users that abandon the funnel at this step.
funnelStepCompletionRate Completion rate The percentage of users that complete this step of the funnel. This metric is returned as a fraction; for example, 0.588 means 58.8% of users completed this funnel step.