The dimensions and metrics supported in the Analytics Data API queries.
Dimensions
The following dimensions can be requested in reports for any property. Specify the "API Name" in a Dimension's name field for a column of the dimension in the report response.
| API Name | UI Name | Description |
|---|---|---|
| achievementId | Achievement ID | The achievement ID in a game for an event. Populated by the event parameter 'achievement_id'. |
| adFormat | Ad format | Describes the way ads looked and where they were located. Typical formats include 'Interstitial', 'Banner', 'Rewarded', and 'Native advanced'. |
| adSourceName | Ad source | The source network that served the ad. Typical sources include 'AdMob Network', 'Liftoff', 'Facebook Audience Network', and 'Mediated house ads'. |
| adUnitName | Ad unit | 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 | The app's versionName (Android) or short bundle version (iOS). |
| audienceName | Audience name | 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 | The resource name of this audience. Resource names contain both collection & resource identifiers to uniquely identify a resource; to learn more, see https://google.aip.dev/122. |
| brandingInterest | Interests | 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 | The browsers used to view your website. |
| campaignId | Campaign ID | The identifier of the marketing campaign. Present only for conversion events. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns. |
| campaignName | Campaign | The name of the marketing campaign. Present only for conversion events. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns. |
| character | Character | The player character in a game for an event. Populated by the event parameter 'character'. |
| city | City | The city from which the user activity originated. |
| cityId | City ID | The geographic ID of the city from which the user activity originated, derived from their IP address. |
| cohort | Cohort | 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 | 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 | 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 | 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 | A category that applies to items of published content. Populated by the event parameter 'content_group'. |
| contentId | Content ID | The identifier of the selected content. Populated by the event parameter 'content_id'. |
| contentType | Content type | The category of the selected content. Populated by the event parameter 'content_type'. |
| continent | Continent | The continent from which the user activity originated. For example, 'Americas' or 'Asia'. |
| continentId | Continent ID | The geographic ID of the continent from which the user activity originated, derived from their IP address. |
| country | Country | The country from which the user activity originated. |
| countryId | Country ID | 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 | 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 | The date of the event, formatted as YYYYMMDD. |
| dateHour | Date + hour (YYYYMMDDHH) | The combined values of date and hour formatted as YYYYMMDDHH. |
| dateHourMinute | Date hour and minute | The combined values of date, hour, and minute formatted as YYYYMMDDHHMM. |
| day | Day | The day of the month, a two-digit number from 01 to 31. |
| dayOfWeek | Day of week | The integer day of the week. It returns values in the range [0,6] with Sunday as the first day of the week. |
| dayOfWeekName | Day of week name | The day of the week in English. This dimension has values of Sunday, Monday, etc. |
| defaultChannelGroup | Default channel group | The conversion'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 | The type of device: Desktop, Tablet, or Mobile. |
| deviceModel | Device model | The mobile device model (example: iPhone 10,6). |
| eventName | Event name | The name of the event. |
| fileExtension | File extension | 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 | 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 | The date the user's first session occurred, formatted as YYYYMMDD. |
| firstUserCampaignId | First user campaign ID | Identifier of the marketing campaign that first acquired the user. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns. |
| firstUserCampaignName | First user campaign | Name of the marketing campaign that first acquired the user. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns. |
| firstUserDefaultChannelGroup | First user default channel group | 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'. |
| firstUserGoogleAdsAccountName | First user Google Ads account name | The Account name from Google Ads that first acquired the user. |
| firstUserGoogleAdsAdGroupId | First user Google Ads ad group ID | The Ad Group Id in Google Ads that first acquired the user. |
| firstUserGoogleAdsAdGroupName | First user Google Ads ad group name | The Ad Group Name in Google Ads that first acquired the user. |
| firstUserGoogleAdsAdNetworkType | First user Google Ads ad network type | 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 | Identifier of the Google Ads marketing campaign that first acquired the user. |
| firstUserGoogleAdsCampaignName | First user Google Ads campaign | Name of the Google Ads marketing campaign that first acquired the user. |
| firstUserGoogleAdsCampaignType | First user Google Ads campaign type | 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 https://support.google.com/google-ads/answer/2567043. |
| firstUserGoogleAdsCreativeId | First user Google Ads creative ID | The ID of the Google Ads creative that first acquired the user. Creative IDs identify individual ads. |
| firstUserGoogleAdsCustomerId | First user Google Ads customer ID | 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 | 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 | The search query that first acquired the user. |
| firstUserManualAdContent | First user manual ad content | The ad content that first acquired the user. Populated by the utm_content parameter. |
| firstUserManualTerm | First user manual term | The term that first acquired the user. Populated by the utm_term parameter. |
| firstUserMedium | First user medium | The medium that first acquired the user to your website or app. |
| firstUserSource | First user source | The source that first acquired the user to your website or app. |
| firstUserSourceMedium | First user source / medium | The combined values of the dimensions 'firstUserSource' and 'firstUserMedium'. |
| firstUserSourcePlatform | First user source platform | 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 | 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. |
| googleAdsAccountName | Google Ads account name | 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 | The ad group id attributed to the conversion event. |
| googleAdsAdGroupName | Google Ads ad group name | The ad group name attributed to the conversion event. |
| googleAdsAdNetworkType | Google Ads ad network type | 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)'. |
| googleAdsCampaignId | Google Ads campaign ID | The campaign ID for the Google Ads campaign attributed to the conversion event. |
| googleAdsCampaignName | Google Ads campaign | The campaign name for the Google Ads campaign attributed to the conversion event. |
| googleAdsCampaignType | Google Ads campaign type | 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, Demand Gen, App, Smart, Hotel, Local, and Performance Max. To learn more, see https://support.google.com/google-ads/answer/2567043. |
| googleAdsCreativeId | Google Ads creative ID | The ID of the Google Ads creative attributed to the conversion event. Creative IDs identify individual ads. |
| googleAdsCustomerId | Google Ads customer ID | 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 | 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 | The search query that led to the conversion event. |
| groupId | Group ID | The player group ID in a game for an event. Populated by the event parameter 'group_id'. |
| hostName | Hostname | 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 | 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 | 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. |
| isoWeek | ISO week of the year | 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 | 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 | The combined values of isoWeek and isoYear. Example values include 201652 & 201701. |
| itemAffiliation | Item affiliation | 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 | Brand name of the item. |
| itemCategory | Item category | 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 | 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 | 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 | 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 | 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 | The ID of the item. |
| itemListId | Item list ID | The ID of the item list. |
| itemListName | Item list name | The name of the item list. |
| itemListPosition | Item list position | The position of an item (e.g., 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 | The physical location associated with the item (e.g. 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 | The name of the item. |
| itemPromotionCreativeName | Item promotion creative name | The name of the item-promotion creative. |
| itemPromotionCreativeSlot | Item promotion creative slot | 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 | The ID of the item promotion. |
| itemPromotionName | Item promotion name | The name of the promotion for the item. |
| itemVariant | Item variant | 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 | The page path associated with the first pageview in a session. |
| landingPagePlusQueryString | Landing page + query string | The page path + query string associated with the first pageview in a session. |
| language | Language | The language setting of the user's browser or device. e.g. English |
| languageCode | Language code | The language setting (ISO 639) of the user's browser or device. e.g. 'en-us' |
| level | Level | The player's level in a game. Populated by the event parameter 'level'. |
| linkClasses | Link classes | 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 | 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 | 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 | The link text of the file download. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter 'link_text'. |
| linkUrl | Link URL | 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 | The ad content attributed to the conversion event. Populated by the utm_content parameter. |
| manualTerm | Manual term | The term attributed to the conversion event. Populated by the utm_term parameter. |
| medium | Medium | The medium attributed to the conversion event. |
| method | Method | The method by which an event was triggered. Populated by the event parameter 'method'. |
| minute | Minute | 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 | Manufacturer or branded name (examples: Samsung, HTC, Verizon, T-Mobile). |
| mobileDeviceMarketingName | Device | The branded device name (examples: Galaxy S10 or P30 Pro). |
| mobileDeviceModel | Mobile model | The mobile device model name (examples: iPhone X or SM-G950F). |
| month | Month | The month of the event, a two digit integer from 01 to 12. |
| newVsReturning | New / returning | 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 | The number of days since the start of the date range. |
| nthHour | Nth hour | The number of hours since the start of the date range. The starting hour is 0000. |
| nthMinute | Nth minute | The number of minutes since the start of the date range. The starting minute is 0000. |
| nthMonth | Nth month | The number of months since the start of a date range. The starting month is 0000. |
| nthWeek | Nth week | A number representing the number of weeks since the start of a date range. |
| nthYear | Nth year | The number of years since the start of the date range. The starting year is 0000. |
| operatingSystem | Operating system | 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 | 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 | The operating system and version. For example, Android 10 or Windows 7. |
| orderCoupon | Order coupon | Code for the order-level coupon. |
| outbound | Outbound | 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 | 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 | 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 | 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 | 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 | The web page titles used on your site. |
| percentScrolled | Percent scrolled | 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 | 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 | The platform and type of device on which your website or mobile app ran. (example: Android / mobile) |
| region | Region | The geographic region from which the user activity originated, derived from their IP address. |
| screenResolution | Screen resolution | The screen resolution of the user's monitor. For example, 1920x1080. |
| searchTerm | Search term | 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'. |
| sessionCampaignId | Session campaign ID | The marketing campaign id for a session. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns. |
| sessionCampaignName | Session campaign | The marketing campaign name for a session. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns. |
| sessionDefaultChannelGroup | Session default channel group | 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'. |
| sessionGoogleAdsAccountName | Session Google Ads account name | 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 | The Ad Group Id in Google Ads for a session. |
| sessionGoogleAdsAdGroupName | Session Google Ads ad group name | The Ad Group Name in Google Ads for a session. |
| sessionGoogleAdsAdNetworkType | Session Google Ads ad network type | 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 | The Campaign ID for the Google Ads Campaign that led to this session. |
| sessionGoogleAdsCampaignName | Session Google Ads campaign | The Campaign name for the Google Ads Campaign that led to this session. |
| sessionGoogleAdsCampaignType | Session Google Ads campaign type | 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 https://support.google.com/google-ads/answer/2567043. |
| sessionGoogleAdsCreativeId | Session Google Ads creative ID | 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 | 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 | 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 | The search query that led to the session. |
| sessionManualAdContent | Session manual ad content | The ad content that led to a session. Populated by the utm_content parameter. |
| sessionManualTerm | Session manual term | The term that led to a session. Populated by the utm_term parameter. |
| sessionMedium | Session medium | The medium that initiated a session on your website or app. |
| sessionSa360AdGroupName | Session SA360 ad group name | The Ad Group name from Search Ads 360 that led to this session. |
| sessionSa360CampaignId | Session SA360 campaign ID | The Campaign ID from Search Ads 360 that led to this session. |
| sessionSa360CampaignName | Session SA360 campaign | The Campaign name from Search Ads 360 that led to this session. |
| sessionSa360CreativeFormat | Session SA360 creative format | 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 | The ID of the engine account in SA360 that led to this session. |
| sessionSa360EngineAccountName | Session SA360 engine account name | The name of the engine account in SA360 that led to this session. |
| sessionSa360EngineAccountType | Session SA360 engine account type | 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 | The search engine keyword from Search Ads 360 that led to this session. |
| sessionSa360Medium | Session SA360 medium | The search engine keyword from Search Ads 360 that led to this session. For example, 'cpc'. |
| sessionSa360Query | Session SA360 query | The search query from Search Ads 360 that led to this session. |
| sessionSa360Source | Session SA360 source | The source of the traffic from Search Ads 360 that led to this session. For example, 'example.com' or 'google'. |
| sessionSource | Session source | The source that initiated a session on your website or app. |
| sessionSourceMedium | Session source / medium | The combined values of the dimensions 'sessionSource' and 'sessionMedium'. |
| sessionSourcePlatform | Session source platform | 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 | 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 | 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 | The source attributed to the conversion event. |
| sourceMedium | Source / medium | The combined values of the dimensions 'source' and 'medium'. |
| sourcePlatform | Source platform | 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 | The numeric data stream identifier for your app or website. |
| streamName | Stream name | The data stream name for your app or website. |
| testDataFilterId | Test data filter ID | 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 https://support.google.com/analytics/answer/10108813. |
| testDataFilterName | Test data filter name | 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 | The ID of the ecommerce transaction. |
| unifiedPagePathScreen | Page path and screen class | The page path (web) or screen class (app) on which the event was logged. |
| unifiedPageScreen | Page path + query string and screen class | The page path and query string (web) or screen class (app) on which the event was logged. |
| unifiedScreenClass | Page title and screen class | The page title (web) or screen class (app) on which the event was logged. |
| unifiedScreenName | Page title and screen name | The page title (web) or screen name (app) on which the event was logged. |
| userAgeBracket | Age | User age brackets. |
| userGender | Gender | User gender. |
| videoProvider | Video provider | 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 | 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 | 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 | 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 | 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 | 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 | The four-digit year of the event e.g. 2020. |
| yearMonth | Year month | The combined values of year and month. Example values include 202212 or 202301. |
| yearWeek | Year week | 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 | Description |
|---|---|
| customEvent:parameter_name | Event-scoped Custom Dimension for parameter_name |
| customEvent:parameter_name[event_name] | Event-scoped Custom Dimension for parameter_name if registered before October 2020 |
| customUser:parameter_name | 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 requested in reports for any property. Specify the "API Name" in a Metric's name field for a column of the metric in the report response.
| API Name | UI Name | Description |
|---|---|---|
| active1DayUsers | 1-day active users | The number of distinct active users on your site or app within a 1 day period. The 1 day period includes the last day in the report's date range. Note: this is the same as Active Users. |
| active28DayUsers | 28-day active users | The number of distinct active users on your site or app within a 28 day period. The 28 day period includes the last day in the report's date range. |
| active7DayUsers | 7-day active users | The number of distinct active users on your site or app within a 7 day period. The 7 day period includes the last day in the report's date range. |
| activeUsers | Active users | The number of distinct users who visited your site or app. |
| adUnitExposure | Ad unit exposure | The time that an ad unit was exposed to a user, in milliseconds. |
| addToCarts | Add to carts | The number of times users added items to their shopping carts. |
| advertiserAdClicks | Ads clicks | Total number of times users have clicked on an ad to reach the property. Includes clicks from linked integrations like linked Search Ads 360 advertisers. Also includes uploaded clicks from data import. |
| advertiserAdCost | Ads cost | The total amount you paid for your ads. Includes costs from linked integrations like linked Google Ads accounts. Also includes uploaded cost from data import; to learn more, see Import cost data. |
| advertiserAdCostPerClick | Ads cost per click | Ads cost per click is ad cost divided by ad clicks and is often abbreviated CPC. |
| advertiserAdCostPerConversion | Cost per conversion | Cost per conversion is ad cost divided by conversions. |
| advertiserAdImpressions | Ads impressions | The total number of impressions. Includes impressions from linked integrations like linked Display & Video 360 advertisers. Also includes uploaded impressions from data import. |
| averagePurchaseRevenue | Average purchase revenue | The average purchase revenue in the transaction group of events. |
| averagePurchaseRevenuePerPayingUser | ARPPU | Average revenue per paying user (ARPPU) is the total purchase revenue per active user that logged a purchase event. The summary metric is for the time period selected. |
| averagePurchaseRevenuePerUser | Average purchase revenue per user | The average purchase revenue per active user is the total purchase revenue per active user that logged any event. The summary metric is for the time period selected. |
| averageRevenuePerUser | ARPU | Average revenue per active user (ARPU). The summary metric is for the time period selected. ARPU uses Total Revenue and includes AdMob estimated earnings. |
| averageSessionDuration | Average session duration | The average duration (in seconds) of users' sessions. |
| bounceRate | Bounce rate | The percentage of sessions that were not engaged ((Sessions Minus Engaged sessions) divided by Sessions). This metric is returned as a fraction; for example, 0.2761 means 27.61% of sessions were bounces. |
| cartToViewRate | Cart-to-view rate | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). This metric is returned as a fraction; for example, 0.1132 means 11.32% of users who viewed a product also added the same product to their cart. |
| checkouts | Checkouts | The number of times users started the checkout process. This metric counts the occurrence of the 'begin_checkout' event. |
| cohortActiveUsers | Cohort active users | The number of users in the cohort who are active in the time window corresponding to the cohort nth day/week/month. For example for the row where cohortNthWeek = 0001, this metric is the number of users (in the cohort) who are active in week 1. |
| cohortTotalUsers | Cohort total users | The total number of users in the cohort. This metric is the same value in every row of the report for each cohort. Because cohorts are defined by a shared acquisition date, cohortTotalUsers is the same as cohortActiveUsers for the cohort's selection date range. For report rows later than the ochort's selection range, it is typical for cohortActiveUsers to be smaller than cohortTotalUsers. This difference represents users from the cohort that were not active for the later date. cohortTotalUsers is commonly used in the metric expression cohortActiveUsers/cohortTotalUsers to compute a user retention fraction for the cohort. The relationship between activeUsers and totalUsers is not equivalent to the relationship between cohortActiveUsers and cohortTotalUsers. |
| conversions | Conversions | The count of conversion events. 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. |
| crashAffectedUsers | Crash-affected users | The number of users that logged a crash in this row of the report. For example if the report is time series by date, this metrics reports total users with at least one crash on this date. Crashes are events with the name "app_exception". |
| crashFreeUsersRate | Crash-free users rate | The number of users without crash events (in this row of the report) divided by the total number of users. This metric is returned as a fraction; for example, 0.9243 means 92.43% of users were crash-free. |
| dauPerMau | DAU / MAU | The rolling percent of 30-day active users who are also 1-day active users. This metric is returned as a fraction; for example, 0.113 means 11.3% of 30-day active users were also 1-day active users. |
| dauPerWau | DAU / WAU | The rolling percent of 7-day active users who are also 1-day active users. This metric is returned as a fraction; for example, 0.082 means 8.2% of 7-day active users were also 1-day active users. |
| ecommercePurchases | Ecommerce purchases | The number of times users completed a purchase. This metric counts 'purchase' events; this metric does not count 'in_app_purchase' and subscription events. |
| engagedSessions | Engaged sessions | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. |
| engagementRate | Engagement rate | The percentage of engaged sessions (Engaged sessions divided by Sessions). This metric is returned as a fraction; for example, 0.7239 means 72.39% of sessions were engaged sessions. |
| eventCount | Event count | The count of events. |
| eventCountPerUser | Event count per user | The average number of events per user (Event count divided by Active users). |
| eventValue | Event value | The sum of the event parameter named 'value'. |
| eventsPerSession | Events per session | The average number of events per session (Event count divided by Sessions). |
| firstTimePurchaserConversionRate | First-time purchaser conversion | The percentage of active users who made their first purchase. This metric is returned as a fraction; for example, 0.092 means 9.2% of active users were first time purchasers. |
| firstTimePurchasers | First time purchasers | The number of users that completed their first purchase event. |
| firstTimePurchasersPerNewUser | First-time purchasers per new user | The average number of first time purchasers per new user. |
| grossItemRevenue | Gross item revenue | The total revenue from items only. Gross item revenue is the product of its price and quantity. Item revenue excludes tax and shipping values; tax & shipping values are specified at the event and not item level. Gross item revenue does not include refunds. |
| grossPurchaseRevenue | Gross purchase revenue | The sum of revenue from purchases made in your app or site. Gross purchase revenue sums the revenue for these events: 'purchase', 'ecommerce_purchase', 'in_app_purchase', 'app_store_subscription_convert', and 'app_store_subscription_renew'. Purchase revenue is specified by the 'value' parameter in tagging. |
| itemDiscountAmount | Item discount amount | The monetary value of item discounts in eCommerce events. This metric is populated in tagging by the 'discount' item parameter. |
| itemListClickEvents | Item-list click events | The number of times users clicked an item when it appeared in a list. This metric counts the occurrence of the 'select_item' event. |
| itemListClickThroughRate | Item list click through rate | The number of users who selected a list(s) divided by the number of users who viewed the same list(s). This metric is returned as a fraction; for example, 0.2145 means 21.45% of users who viewed a list also selected the same list. |
| itemListViewEvents | Item-list view events | The number of times the item list was viewed. This metric counts the occurrence of the 'view_item_list' event. |
| itemPromotionClickThroughRate | Item promotion click through rate | The number of users who selected a promotion(s) divided by the number of users who viewed the same promotion(s). This metric is returned as a fraction; for example, 0.1382 means 13.82% of users who viewed a promotion also selected the promotion. |
| itemRefundAmount | Item refund amount | Item refund amount is the total refunded transaction revenue from items only. Item refund amount is the product of price and quantity for the 'refund' event. |
| itemRevenue | Item revenue | The total revenue from purchases minus refunded transaction revenue from items only. Item revenue is the product of its price and quantity. Item revenue excludes tax and shipping values; tax & shipping values are specified at the event and not item level. |
| itemViewEvents | Item view events | The number of times the item details were viewed. The metric counts the occurrence of the 'view_item' event. |
| itemsAddedToCart | Items added to cart | The number of units added to cart for a single item. This metric counts the quantity of items in 'add_to_cart' events. |
| itemsCheckedOut | Items checked out | The number of units checked out for a single item. This metric counts the quantity of items in 'begin_checkout' events. |
| itemsClickedInList | Items clicked in list | The number of units clicked in list for a single item. This metric counts the quantity of items in 'select_item' events. |
| itemsClickedInPromotion | Items clicked in promotion | The number of units clicked in promotion for a single item. This metric counts the quantity of items in 'select_promotion' events. |
| itemsPurchased | Items purchased | The number of units for a single item included in purchase events. This metric counts the quantity of items in purchase events. |
| itemsViewed | Items viewed | The number of units viewed for a single item. This metric counts the quantity of items in 'view_item' events. |
| itemsViewedInList | Items viewed in list | The number of units viewed in list for a single item. This metric counts the quantity of items in 'view_item_list' events. |
| itemsViewedInPromotion | Items viewed in promotion | The number of units viewed in promotion for a single item. This metric counts the quantity of items in 'view_promotion' events. |
| newUsers | New users | The number of users who interacted with your site or launched your app for the first time (event triggered: first_open or first_visit). |
| organicGoogleSearchAveragePosition | Organic Google Search average position | The average ranking of your website URLs for the query reported from Search Console. For example, if your site's URL appears at position 3 for one query and position 7 for another query, the average position would be 5 (3+7/2). This metric requires an active Search Console link. |
| organicGoogleSearchClickThroughRate | Organic Google Search click through rate | The organic Google Search click through rate reported from Search Console. Click through rate is clicks per impression. This metric is returned as a fraction; for example, 0.0588 means about 5.88% of impressions resulted in a click. This metric requires an active Search Console link. |
| organicGoogleSearchClicks | Organic Google Search clicks | The number of organic Google Search clicks reported from Search Console. This metric requires an active Search Console link. |
| organicGoogleSearchImpressions | Organic Google Search impressions | The number of organic Google Search impressions reported from Search Console. This metric requires an active Search Console link. |
| promotionClicks | Promotion clicks | The number of times an item promotion was clicked. This metric counts the occurrence of the 'select_promotion' event. |
| promotionViews | Promotion views | The number of times an item promotion was viewed. This metric counts the occurrence of the 'view_promotion' event. |
| publisherAdClicks | Publisher ad clicks | The number of ad_click events. |
| publisherAdImpressions | Publisher ad impressions | The number of ad_impression events. |
| purchaseRevenue | Purchase revenue | The sum of revenue from purchases minus refunded transaction revenue made in your app or site. Purchase revenue sums the revenue for these events: 'purchase', 'ecommerce_purchase', 'in_app_purchase', 'app_store_subscription_convert', and 'app_store_subscription_renew'. Purchase revenue is specified by the 'value' parameter in tagging. |
| purchaseToViewRate | Purchase-to-view rate | The number of users who purchased a product(s) divided by the number of users who viewed the same product(s). This metric is returned as a fraction; for example, 0.128 means 12.8% of users that viewed a product(s) also purchased the same product(s). |
| purchaserConversionRate | Purchaser conversion | The percentage of active users who made 1 or more purchase transactions. This metric is returned as a fraction; for example, 0.412 means 41.2% of users were purchasers. |
| refundAmount | Refund amount | The total refunded transaction revenues. Refund amount sums refunded revenue for the 'refund' and 'app_store_refund' events. |
| returnOnAdSpend | Return on ad spend | Return On Ad Spend (ROAS) is total revenue divided by advertiser ad cost. |
| screenPageViews | Views | The number of app screens or web pages your users viewed. Repeated views of a single page or screen are counted. (screen_view + page_view events). |
| screenPageViewsPerSession | Views per session | The number of app screens or web pages your users viewed per session. Repeated views of a single page or screen are counted. (screen_view + page_view events) / sessions. |
| screenPageViewsPerUser | Views per user | The number of app screens or web pages your users viewed per active user. Repeated views of a single page or screen are counted. (screen_view + page_view events) / active users. |
| scrolledUsers | Scrolled users | The number of unique users who scrolled down at least 90% of the page. |
| sessionConversionRate | Session conversion rate | The percentage of sessions in which any conversion event was triggered. |
| sessions | Sessions | The number of sessions that began on your site or app (event triggered: session_start). |
| sessionsPerUser | Sessions per user | The average number of sessions per user (Sessions divided by Active Users). |
| shippingAmount | Shipping amount | Shipping amount associated with a transaction. Populated by the 'shipping' event parameter. |
| taxAmount | Tax amount | Tax amount associated with a transaction. Populated by the 'tax' event parameter. |
| totalAdRevenue | Total ad revenue | The total advertising revenue from both Admob and third-party sources. |
| totalPurchasers | Total purchasers | The number of users that logged purchase events for the time period selected. |
| totalRevenue | Total revenue | The sum of revenue from purchases, subscriptions, and advertising (Purchase revenue plus Subscription revenue plus Ad revenue) minus refunded transaction revenue. |
| totalUsers | Total users | The number of distinct users who have logged at least one event, regardless of whether the site or app was in use when that event was logged. |
| transactions | Transactions | The count of transaction events with purchase revenue. Transaction events are in_app_purchase, ecommerce_purchase, purchase, app_store_subscription_renew, app_store_subscription_convert, and refund. |
| transactionsPerPurchaser | Transactions per purchaser | The average numer of transactions per purchaser. |
| userConversionRate | User conversion rate | The percentage of users who triggered any conversion event. |
| userEngagementDuration | User engagement | The total amount of time (in seconds) your website or app was in the foreground of users' devices. |
| wauPerMau | WAU / MAU | The rolling percent of 30-day active users who are also 7-day active users. This metric is returned as a fraction; for example, 0.234 means 23.4% of 30-day active users were also 7-day active users. |
Custom Metrics
The Data API can create reports on Event scoped Custom Metrics. See Event-scoped custom dimensions and metrics reporting to learn more about custom metrics. Custom metrics are specified in an API report request by the metric's parameter name and scope. For example, include "customEvent:levels_unlocked" in a Data API request to create a report for the Event-scoped Custom Metric with parameter name "levels_unlocked". This API request will fail if the property has not registered this Event-scoped Custom Metric.
If an Event-scoped Custom Metric was registered before October 2020, the metric must be specified in an API request with its event name. For example, include "customEvent:levels_unlocked[tutorial_start]" for the Event-scoped Custom Metric with parameter name "levels_unlocked" and event name "tutorial_start". In October 2020, Analytics replaced Custom-parameter reporting with Event-scoped custom dimensions and metrics reporting.
The following are the general syntax for Custom Metrics. You can query the Metadata API method to list all Custom Metrics for a Property; here is an example of using the Metadata API method.
| Generic API Name | Description |
|---|---|
| customEvent:parameter_name | Event-scoped Custom Metric for parameter_name |
| customEvent:parameter_name[event_name ] | Event-scoped Custom Metric for parameter_name if registered before October 2020 |
Custom Metric Variants
Each custom metric that a property registers creates three API metric variants: a sum, an average, and a count. Most requests will use the sum of the custom metric. The average of the custom metric is useful for a summary statistic. The count of a custom metric is interesting if the number of occurrences of a parameter is useful to you.
You can query the Metadata API method to list all variants of Custom Metrics for a Property; here is an example of using the Metadata API method for a custom average.
| Generic API Name | Description |
|---|---|
| customEvent:parameter_name | The sum of an Event-scoped Custom Metric for parameter_name |
| averageCustomEvent:parameter_name | The average value of an Event-scoped Custom Metric for parameter_name |
| countCustomEvent:parameter_name | The number of occurrences of an Event-scoped Custom Metric for parameter_name |
Conversion Rate Metrics For One Conversion
Each conversion event that you register on a property creates Conversion Rate metrics that you can request in reports. There are two conversion rate metrics for each conversion: session-based conversion rate for one conversion and user-based conversion rate for one conversion.
You can query the Metadata API method to list all conversion rate metrics for one specific conversion for a Property. If you try to request the conversion rate for an event that is not registered as a conversion, the request will fail. Here is an example of using the Metadata API method for a conversion rate metric for one conversion.
| Generic API Name | Description |
|---|---|
| sessionConversionRate:event_name | The percentage of sessions in which a specific conversion event was triggered. |
| userConversionRate:event_name | The percentage of users who triggered a specific conversion event. |