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's name field.
| API Name | UI Name | Available in Segments | Description |
|---|---|---|---|
| achievementId | Achievement ID | Yes | The achieventment 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. |
| 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 | No | The identifier of the marketing campaign. Present only for conversion events. |
| campaignName | Campaign | No | The name of the marketing campaign. Present only for conversion events. |
| 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. |
| 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: cohort_0, cohort_1, etc. |
| 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'. |
| 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. |
| date | Date | Yes | The date of the event, formatted as YYYYMMDD. |
| dateHour | Date + hour (YYYYMMDDHH) | No | 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 day of the week. It returns values in the range [0,6] with Sunday as the first day of the week. |
| defaultChannelGrouping | Default channel grouping | No | The conversion's default channel grouping 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). |
| 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 | No | Identifier of the marketing campaign that first acquired the user. Includes Google Ads Campaigns. |
| firstUserCampaignName | First user campaign | Yes | Name of the marketing campaign that first acquired the user. Includes Google Ads and Manual Campaigns. |
| firstUserDefaultChannelGrouping | First user default channel grouping | Yes | The default channel grouping that first acquired the user. Default channel grouping 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'. |
| firstUserGoogleAdsAccountName | First user Google Ads account name | No | The Account name from Google Ads that first acquired the user. |
| firstUserGoogleAdsAdGroupId | First user Google Ads ad group ID | No | The Ad Group Id in Google Ads that first acquired the user. |
| firstUserGoogleAdsAdGroupName | First user Google Ads ad group name | No | 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)'. |
| 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, Discovery, App, Smart, Hotel, Local, and Performance Max. To learn more, see https://support.google.com/google-ads/answer/2567043. |
| 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 | No | 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 | No | The matched keyword that first acquired the user. 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 https://support.google.com/google-ads/answer/6323. |
| firstUserGoogleAdsQuery | First user Google Ads query | No | 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. |
| 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. |
| firstUserSource | First user source | Yes | The source that first acquired the user to your website or app. |
| firstUserSourceMedium | First user source / medium | No | The combined values of the dimensions 'firstUserSource' and 'firstUserMedium'. |
| firstUserSourcePlatform | First user source platform | No | The source platform that first acquired the user. Please do not 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 i'th step; this next action is exclusive of the event that attained the i'th step and inclusive of the event that attained the i+1'th step. |
| googleAdsAccountName | Google Ads account name | No | The Account name from Google Ads for the campaign that led to the conversion event. Corresponds to customer.descriptive_name in the Google Ads API. |
| googleAdsAdGroupId | Google Ads ad group ID | No | The ad group id attributed to the conversion event. |
| googleAdsAdGroupName | Google Ads ad group name | No | The ad group name attributed to the conversion event. |
| googleAdsAdNetworkType | Google Ads ad network type | No | The advertising network type of the conversion. An enumeration which includes 'Google search', 'Search partners', 'Google Display Network', 'Youtube Search', 'Youtube Videos', 'Cross-network', 'Social', and '(universal campaign)'. |
| googleAdsCampaignType | Google Ads campaign type | No | The campaign type for the Google Ads campaign attributed to the conversion 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, Discovery, App, Smart, Hotel, Local, and Performance Max. To learn more, see https://support.google.com/google-ads/answer/2567043. |
| googleAdsCreativeId | Google Ads creative ID | No | The ID of the Google Ads creative attributed to the conversion event. Creative IDs identify individual ads. |
| googleAdsCustomerId | Google Ads customer ID | No | The Customer ID from Google Ads for the campaign that led to conversion event. Customer IDs in Google Ads uniquely identify Google Ads accounts. |
| googleAdsKeyword | Google Ads keyword text | No | The matched keyword that led to the conversion 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 https://support.google.com/google-ads/answer/6323. |
| googleAdsQuery | Google Ads query | No | The search query that led to the conversion 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. |
| isConversionEvent | Is conversion event | Yes | The string 'true' if the event is a conversion. Events are marked as conversions at collection time; changes to an event's conversion marking apply going forward. You can mark any event as a conversion in Google Analytics, and some events (i.e. first_open, purchase) are marked as conversions by default. To learn more, see https://support.google.com/analytics/answer/9267568. |
| itemAffiliation | Item affiliation | No | 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 | No | Brand name of the item. |
| itemCategory | Item category | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | The ID of the item. |
| itemListId | Item list ID | No | The ID of the item list. |
| itemListName | Item list name | No | The name of the item list. |
| itemName | Item name | No | The name of the item. |
| itemPromotionCreativeName | Item promotion creative name | No | The name of the item-promotion creative. |
| itemPromotionId | Item promotion ID | No | The ID of the item promotion. |
| itemPromotionName | Item promotion name | No | The name of the promotion for the item. |
| itemVariant | Item variant | No | The specific variation of a product. e.g., XS, S, M, L for size; or Red, Blue, Green, Black for color. Populated by the 'item_variant' parameter. |
| landingPage | Landing page | 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. e.g. English |
| languageCode | Language code | Yes | The language setting (ISO 639) of the user's browser or device. e.g. '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 '', 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 '', 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 '', 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 '', 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 | No | The ad content attributed to the conversion event. Populated by the utm_content parameter. |
| manualTerm | Manual term | No | The term attributed to the conversion event. Populated by the utm_term parameter. |
| medium | Medium | No | The medium attributed to the conversion event. |
| method | Method | Yes | The method by which an event was triggered. Populated by the event parameter 'method'. |
| minute | Minute | No | 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 lead to a site 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) |
| region | Region | Yes | The geographic region from which the user activity originated, derived from their IP address. |
| 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 (i.e. '1. Segment', '2. Segment', etc.). |
| sessionCampaignId | Session campaign ID | No | The marketing campaign id for a session. Includes Manual Campaigns and Campaigns from integration linkages like Google Ads and Search Ads 360. |
| sessionCampaignName | Session campaign | Yes | The marketing campaign name for a session. Includes Manual Campaigns and Campaigns from integration linkages like Google Ads and Search Ads 360. |
| sessionDefaultChannelGrouping | Session default channel grouping | Yes | The session's default channel grouping 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'. |
| sessionGoogleAdsAccountName | Session Google Ads account name | No | 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 | No | The Ad Group Id in Google Ads for a session. |
| sessionGoogleAdsAdGroupName | Session Google Ads ad group name | No | 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)'. |
| 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, Discovery, App, Smart, Hotel, Local, and Performance Max. To learn more, see https://support.google.com/google-ads/answer/2567043. |
| sessionGoogleAdsCreativeId | Session Google Ads creative ID | No | The ID of the Google Ads creative that lead to a session on your website or app. Creative IDs identify individual ads. |
| sessionGoogleAdsCustomerId | Session Google Ads customer ID | No | 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 | No | 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 https://support.google.com/google-ads/answer/6323. |
| sessionGoogleAdsQuery | Session Google Ads query | No | 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. |
| 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. |
| sessionSa360AdGroupName | Session SA360 ad group name | No | The Ad Group name from Search Ads 360 that led to this session. |
| sessionSa360CampaignName | Session SA360 campaign | No | The Campaign name from Search Ads 360 that led to this session. |
| sessionSa360CreativeFormat | Session SA360 creative format | No | The type of creative in Search Ads 360 that led to this session. For example, 'Responsive search ad' or 'Expanded text ad'. To learn more, see GA4 Traffic Source Dimensions. |
| sessionSa360EngineAccountId | Session SA360 engine account ID | No | The ID of the engine account in SA360 that led to this session. |
| sessionSa360EngineAccountName | Session SA360 engine account name | No | The name of the engine account in SA360 that led to this session. |
| sessionSa360EngineAccountType | Session SA360 engine account type | No | The type of the engine account in Search Ads 360 that led to this session. For example, 'google ads', 'bing', or 'baidu'. |
| sessionSa360Keyword | Session SA360 keyword text | No | The search engine keyword from Search Ads 360 that led to this session. |
| sessionSa360Medium | Session SA360 medium | No | The search engine keyword from Search Ads 360 that led to this session. For example, 'cpc'. |
| sessionSa360Query | Session SA360 query | No | The search query from Search Ads 360 that led to this session. |
| sessionSa360Source | Session SA360 source | No | The source of the traffic from Search Ads 360 that led to this session. For example, 'example.com' or 'google'. |
| sessionSource | Session source | Yes | The source that initiated a session on your website or app. |
| sessionSourceMedium | Session source / medium | No | The combined values of the dimensions 'sessionSource' and 'sessionMedium'. |
| sessionSourcePlatform | Session source platform | No | The source platform of the session's campaign. Please do not 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 (e.g. Ground, Air, Next-day) selected for delivery of the purchased item. 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 https://support.google.com/analytics/answer/9213390. |
| source | Source | No | The source attributed to the conversion event. |
| sourceMedium | Source / medium | No | The combined values of the dimensions 'source' and 'medium'. |
| sourcePlatform | Source platform | No | The source platform of the conversion event's campaign. Please do not 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. |
| 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 https://support.google.com/analytics/answer/10108813. |
| 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. i.e. 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 e.g. 2020. |
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 this article on Custom channel groups in GA4. 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 conversion 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. |