Columns¶
This article documents core columns available in the HTTP API. Additional columns may become available through Integrations.
Note
Each column listed in this document defines a Scope attribute. If you request a query that includes at least one column which requires event scope, the entire query will be calculated using events, instead of sessions. This might distort some custom metrics such as averages of a session dimension (e.g. average session time).
Metrics¶
The table below lists core metrics that may be used in queries. Additional metrics may be created using dimension transformations.
Metric Name | Column ID | Scope | Type |
---|---|---|---|
Events | events | session | int |
Consent form impressions | consent_form_impressions | event | int |
Consent form clicks | consent_form_clicks | event | int |
First consents | consents_first | event | int |
Changed consents | consents_changed | event | int |
Full consents | consents_full | event | int |
Any consents | consents_any | event | int |
No consents | consents_none | event | int |
No decisions | consents_no_decision | event | int |
Analytics consents | consents_analytics | event | int |
A/B testing personalization consents | consents_ab_testing_personalization | event | int |
Conversion tracking consents | consents_conversion_tracking | event | int |
Marketing automation consents | consents_marketing_automation | event | int |
Remarketing consents | consents_remarketing | event | int |
User feedback consents | consents_user_feedback | event | int |
Custom consent 1 | consents_custom_1 | event | int |
Page views | page_views | session | int |
Unique page views | unique_page_views | session | int |
Entries | entries | session | int |
Exits | exits | session | int |
Bounces | bounces | session | int |
Sessions | sessions | session | int |
Visitors | visitors | session | int |
% of returning visitors | returning_visitors_rate | session | float |
Users | users | session | int |
Visitor IPs | visitor_ips | session | int |
Outlinks | outlinks | session | int |
Unique outlinks | unique_outlinks | session | int |
Downloads | downloads | session | int |
Unique downloads | unique_downloads | session | int |
Searches | searches | session | int |
Unique searches | unique_searches | session | int |
Custom events | custom_events | session | int |
Unique custom events | unique_custom_events | session | int |
Content impressions | content_impressions | session | int |
Unique content impressions | unique_content_impressions | session | int |
Content interactions | content_interactions | session | int |
Unique content interactions | unique_content_interactions | session | int |
Goal conversions | goal_conversions | session | int |
Unique goal conversions | unique_goal_conversions | session | int |
Ecommerce conversions | ecommerce_conversions | session | int |
Ecommerce abandoned carts | ecommerce_abandoned_carts | session | int |
Unique purchases | unique_purchases | event | int |
Entry rate | entry_rate | session | float |
Exit rate | exit_rate | session | float |
Exit rate events | exit_rate_events | session | float |
Bounce rate | bounce_rate | session | float |
Bounce rate | bounce_rate_events | session | float |
Content interaction rate | content_interaction_rate | session | float |
Goal conversion rate | goal_conversion_rate | session | float |
Ecommerce conversion rate | ecommerce_conversion_rate | session | float |
Events per session | events_per_session | session | float |
Dimensions¶
The table below lists core dimensions that may be used in queries.
Note: “Database type” column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable).
Dimension Name | Column ID | Scope | Type | Database Type | Nullable | Notes |
---|---|---|---|---|---|---|
Visitor ID | visitor_id | session | hex | uint64 | False | by default in Raw data API |
User ID | user_id | session | str | string | False | |
Cookie ID | cookie_id | session | hex | uint64 | False | |
Returning visitor | visitor_returning | session | [int, str] | uint8 | False | visitor_returning.json |
Session number | visitor_session_number | session | int | uint16 | False | |
Days since last session | visitor_days_since_last_session | session | int | uint16 | True | |
Days since first session | visitor_days_since_first_session | session | int | uint16 | True | |
Days since order | visitor_days_since_order | session | int | uint16 | True | |
Events in session | session_total_events | session | int | uint16 | False | |
Session time | session_total_time | session | int | uint32 | False | |
Page views in session | session_total_page_views | session | int | uint16 | False | |
Outlinks in session | session_total_outlinks | session | int | uint16 | False | |
Downloads in session | session_total_downloads | session | int | uint16 | False | |
Site searches in session | session_total_site_searches | session | int | uint16 | False | |
Custom events in session | session_total_custom_events | session | int | uint16 | False | |
Content impressions in session | session_total_content_impressions | session | int | uint16 | False | |
Content interactions in session | session_total_content_interactions | session | int | uint16 | False | |
Goal conversions in session | session_total_goal_conversions | session | int | uint16 | False | |
Ecommerce conversions in session | session_total_ecommerce_conversions | session | int | uint16 | False | |
Abandoned carts in session | session_total_abandoned_carts | session | int | uint16 | False | |
Unique page views in session | session_unique_page_views | session | int | uint16 | False | |
Unique outlinks in session | session_unique_outlinks | session | int | uint16 | False | |
Unique downloads in session | session_unique_downloads | session | int | uint16 | False | |
Unique site searches in session | session_unique_searches | session | int | uint16 | False | |
Unique custom events in session | session_unique_custom_events | session | int | uint16 | False | |
Unique content impressions in session | session_unique_content_impressions | session | int | uint16 | False | |
Unique content interactions in session | session_unique_content_interactions | session | int | uint16 | False | |
Goals converted in session | session_goals | session | array | array of int32 | False | |
Shopping stage | session_ecommerce_status | session | [int, str] | uint8 | False | session_ecommerce_status.json |
Source | source | session | str | string | False | |
Medium | medium | session | str | string | False | |
Source/Medium | source_medium | session | str | string | False | |
Keyword | keyword | session | str | string | False | |
Channel | referrer_type | session | [int, str] | uint8 | False | referrer_type.json |
Referrer URL | referrer_url | session | str | string | False | |
Campaign name | campaign_name | session | str | string | False | |
Campaign ID | campaign_id | session | str | string | False | |
Campaign content | campaign_content | session | str | string | False | |
Google Click ID | campaign_gclid | session | str | string | True | |
Operating system | operating_system | session | [str, str] | string(3) | True | operating_system.json |
Operating system version | operating_system_version | session | str | string | False | |
Browser engine | browser_engine | session | str | string | False | |
Browser name | browser_name | session | [str, str] | string(2) | True | browser_name.json |
Browser version | browser_version | session | str | string | False | |
Browser language | browser_language_iso639 | session | [str, str] | string(2) | True | browser_language_iso639.json |
Browser fingerprint | browser_fingerprint | session | int | uint64 | False | not available in Queries API |
Device type | device_type | session | [int, str] | uint8 | True | device_type.json |
Device brand | device_brand | session | [str, str] | string(2) | True | device_brand.json |
Device model | device_model | session | str | string | False | |
Resolution | resolution | session | str | string | True | |
Resolution width | resolution_width | session | int | uint16 | True | |
Resolution height | resolution_height | session | int | uint16 | True | |
PDF plugin | plugin_pdf | session | int(0,1) | uint8 | False | |
Flash plugin | plugin_flash | session | int(0,1) | uint8 | False | |
Java plugin | plugin_java | session | int(0,1) | uint8 | False | |
Director plugin | plugin_director | session | int(0,1) | uint8 | False | |
QuickTime plugin | plugin_quicktime | session | int(0,1) | uint8 | False | |
RealPlayer plugin | plugin_realplayer | session | int(0,1) | uint8 | False | |
Windows Media Player plugin | plugin_windowsmedia | session | int(0,1) | uint8 | False | |
Gears plugin | plugin_gears | session | int(0,1) | uint8 | False | |
Silverlight plugin | plugin_silverlight | session | int(0,1) | uint8 | False | |
Cookie support | plugin_cookie | session | int(0,1) | uint8 | False | |
Continent | location_continent_iso_code | session | [str, str] | string(2) | True | location_continent_iso_code.json |
Country | location_country_name | session | [str, str] | string | True | ISO 3166-2 codes (e.g. “PL”) |
Subdivision | location_subdivision_1_name | session | [str, str] | string | True | ISO 3166-2 codes (e.g. “PL-DS”) |
Subdivision 2 | location_subdivision_2_name | session | [str, str] | string | True | ISO 3166-2 codes (e.g. “ES-M”) |
City | location_city_name | session | [int, str] | string | True | unique identifiers as specified by GeoNames |
Designated market area | location_metro_code | session | [str, str] | string(3) | True | location_metro_code.json |
Latitude | location_latitude | session | float | float64 | True | |
Longitude | location_longitude | session | float | float64 | True | |
Provider | location_provider | session | str | string | False | |
Organization | location_organization | session | str | string | False | |
Session exit URL | session_exit_url | session | str | string | False | |
Session exit title | session_exit_title | session | str | string | False | |
Session entry URL | session_entry_url | session | str | string | False | |
Session entry title | session_entry_title | session | str | string | False | |
Session second URL | session_second_url | session | str | string | False | |
Session second title | session_second_title | session | str | string | False | |
Session bounce | is_bounce | session | int(0,1) | uint8 | False | |
Event ID | event_id | event | int | uint64 | False | by default in Raw data API |
Session ID | session_id | session | int | uint64 | False | by default in Raw data API |
Exit view | is_exit | event | int(0,1) | uint8 | False | not available in Queries API |
Entry view | is_entry | event | int(0,1) | uint8 | False | not available in Queries API |
Event type | event_type | event | [int, str] | uint8 | False | event_type.json |
Page URL | event_url | event | str | string | False | |
Page title | event_title | event | str | string | False | |
Outlink URL | outlink_url | event | str | string | False | |
Download URL | download_url | event | str | string | False | |
Search keyword | search_keyword | event | str | string | False | |
Search category | search_category | event | str | string | False | |
Search results count | search_results_count | event | int | uint16 | True | |
Custom event category | custom_event_category | event | str | string | False | |
Custom event action | custom_event_action | event | str | string | False | |
Custom event name | custom_event_name | event | str | string | False | |
Custom event value | custom_event_value | event | float | float64 | True | |
Content name | content_name | event | str | string | False | |
Content piece | content_piece | event | str | string | False | |
Content target | content_target | event | str | string | False | |
Previous page view URL | previous_event_url | event | str | string | False | |
Previous page view title | previous_event_title | event | str | string | False | |
Next page view URL | next_event_url | event | str | string | False | |
Next page view title | next_event_title | event | str | string | False | |
Event index | event_index | event | int | uint16 | False | not available in Queries API |
Page view index | page_view_index | event | int | uint16 | True | not available in Queries API |
Time on page | time_on_page | event | int | uint32 | True | |
Page generation time | page_generation_time | event | float | float64 | True | |
Goal name | goal_id | event | [int, str] | int32 | True | goal IDs from Analytics |
Goal revenue | goal_revenue | event | float | float64 | True | |
Lost revenue | lost_revenue | event | float | float64 | True | |
Order ID | order_id | event | str | string | False | |
Item count | item_count | event | int | uint16 | True | |
Revenue | revenue | event | float | float64 | True | |
Revenue (Subtotal) | revenue_subtotal | event | float | float64 | True | |
Revenue (Tax) | revenue_tax | event | float | float64 | True | |
Revenue (Shipping) | revenue_shipping | event | float | float64 | True | |
Revenue (Discount) | revenue_discount | event | float | float64 | True | |
Time until DOM is ready | timing_dom_interactive | event | int | uint32 | True | |
Time to interact | timing_event_end | event | int | uint32 | True | |
Consent form view source | consent_source | event | [int, str] | uint8 | True | consent_source.json |
Consent form interaction type | consent_form_button | event | [int, str] | uint8 | True | consent_form_button.json |
Consent scope | consent_scope | event | [int, str] | uint8 | True | consent_scope.json |
Consent action | consent_action | event | [int, str] | uint8 | True | consent_action.json |
Analytics consent | consent_type_analytics | event | int(0,1) | uint8 | True | |
AB testing personalization consent | consent_type_ab_testing_personalization | event | int(0,1) | uint8 | True | |
Conversion tracking consent | consent_type_conversion_tracking | event | int(0,1) | uint8 | True | |
Marketing automation consent | consent_type_marketing_automation | event | int(0,1) | uint8 | True | |
Remarketing consent | consent_type_remarketing | event | int(0,1) | uint8 | True | |
User feedback consent | consent_type_user_feedback | event | int(0,1) | uint8 | True | |
Custom consent 1 | consent_type_custom_1 | event | int(0,1) | uint8 | True | |
Event custom dimension 1 | event_custom_dimension_1 | event | str | string | False | |
Event custom dimension 2 | event_custom_dimension_2 | event | str | string | False | |
Event custom dimension 3 | event_custom_dimension_3 | event | str | string | False | |
Event custom dimension 4 | event_custom_dimension_4 | event | str | string | False | |
Event custom dimension 5 | event_custom_dimension_5 | event | str | string | False | |
Event custom variable key 1 | event_custom_variable_key_1 | event | str | string | False | |
Event custom variable value 1 | event_custom_variable_value_1 | event | str | string | False | |
Event custom variable key 2 | event_custom_variable_key_2 | event | str | string | False | |
Event custom variable value 2 | event_custom_variable_value_2 | event | str | string | False | |
Event custom variable key 3 | event_custom_variable_key_3 | event | str | string | False | |
Event custom variable value 3 | event_custom_variable_value_3 | event | str | string | False | |
Event custom variable key 4 | event_custom_variable_key_4 | event | str | string | False | |
Event custom variable value 4 | event_custom_variable_value_4 | event | str | string | False | |
Event custom variable key 5 | event_custom_variable_key_5 | event | str | string | False | |
Event custom variable value 5 | event_custom_variable_value_5 | event | str | string | False | |
Session custom dimension 1 | session_custom_dimension_1 | session | str | string | False | |
Session custom dimension 2 | session_custom_dimension_2 | session | str | string | False | |
Session custom dimension 3 | session_custom_dimension_3 | session | str | string | False | |
Session custom dimension 4 | session_custom_dimension_4 | session | str | string | False | |
Session custom dimension 5 | session_custom_dimension_5 | session | str | string | False | |
Session custom variable key 1 | session_custom_variable_key_1 | session | str | string | False | |
Session custom variable value 1 | session_custom_variable_value_1 | session | str | string | False | |
Session custom variable key 2 | session_custom_variable_key_2 | session | str | string | False | |
Session custom variable value 2 | session_custom_variable_value_2 | session | str | string | False | |
Session custom variable key 3 | session_custom_variable_key_3 | session | str | string | False | |
Session custom variable value 3 | session_custom_variable_value_3 | session | str | string | False | |
Session custom variable key 4 | session_custom_variable_key_4 | session | str | string | False | |
Session custom variable value 4 | session_custom_variable_value_4 | session | str | string | False | |
Session custom variable key 5 | session_custom_variable_key_5 | session | str | string | False | |
Session custom variable value 5 | session_custom_variable_value_5 | session | str | string | False | |
Timestamp | timestamp | session | date | not applicable | False | by default in Raw data API |
Local hour | local_hour | session | int | not applicable | False | |
Time of redirections | redirections_time | event | int | not applicable | True | |
Domain Lookup Time | domain_lookup_time | event | int | not applicable | True | |
Server Connection Time | server_connection_time | event | int | not applicable | True | |
Server Response Time | server_response_time | event | int | not applicable | True | |
Page Rendering Time | page_rendering_time | event | int | not applicable | True | |
IPv4 address | ipv4_address | session | ipv4 | not applicable | True | |
IPv6 address | ipv6_address | session | ipv6 | not applicable | True | |
Website Name | website_name | session | [str, str] | not applicable | False | website UUID |
Note
Please note that the number of available custom slots (dimensions, variables) depends on your organisation’s configuration.
Transformations¶
The tables below list all transformations that may be used to transform dimensions to metrics or different dimensions.
Transformation Name | Transformation ID | Source Types | Result Type |
---|---|---|---|
Unique Count | unique_count | int, str | int |
Min | min | int, float | (as source) |
Max | max | int, float | (as source) |
Average | average | int, float | float |
Median | median | int, float | (as source) |
Sum | sum | int, float | (as source) |
Transformation Name | Transformation ID | Source Types | Result Type |
---|---|---|---|
Date To Day | to_date | datetime, date | date |
Date To Start Of Hour | to_start_of_hour | datetime | datetime |
Date To Start Of Week | to_start_of_week | datetime, date | date |
Date To Start Of Month | to_start_of_month | datetime, date | date |
Date To Start Of Quarter | to_start_of_quarter | datetime, date | date |
Date To Start Of Year | to_start_of_year | datetime, date | date |
Date To Hour Of Day | to_hour_of_day | datetime | int |
Date To Day Of Week | to_day_of_week | datetime, date | int |
Date To Month Number | to_month_number | datetime, date | int |
URL To Path | to_path | str | str |
URL To Domain | to_domain | str | str |
URL Strip Query String | strip_qs | str | str |