Piwik PRO

Metrics

Here’s a list of core metrics that you can use in API calls. You can create additional metrics using transformations.

abandoned_cart_rate


Name	Cart abandonment rate
Description	The percentage of sessions during which shoppers abandoned their carts. Cart abandonment rate = Sessions with abandoned cart / Sessions * 100%.
Scopes	event, product, session
Availability	Query API
Type	float

bounce_rate


Name	Bounce rate
Description	The percentage of sessions during which visitors viewed only one page and didn’t continue to another page view, goal conversion, or order. Bounce rate = (Bounces / Sessions) * 100%.
Scopes	event, product, session
Availability	Query API
Type	float

bounce_rate_events


Name	Page bounce rate
Description	An accurate bounce rate for a page URL or page title. The percentage of sessions during which visitors viewed only that page and didn’t continue to another page view, goal conversion, or order. Page bounce rate = (Bounces / Entries) * 100%.
Scopes	event, product, session
Availability	Query API
Type	float

bounces


Name	Bounces
Description	The number of sessions during which visitors viewed an entry page but didn’t continue to another page view, goal conversion, or order.
Scopes	event, product, session
Availability	Query API
Type	int

cart_additions


Name	Adds to cart
Description	The number of times shoppers added products to their carts.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

cart_removals


Name	Removes from cart
Description	The number of times shoppers removed products from their carts.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

cart_to_detail_rate


Name	Cart-to-detail rate
Description	The percentage counted as: Product adds to cart / Product detail views * 100%. This metric helps you gauge how product details affect cart additions.
Scopes	event, product, session
Availability	Real-time, Query API
Type	float

consent_form_clicks


Name	Consent form clicks
Description	Clicks on one of the buttons on the form: accept all, reject all, save choices, close.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consent_form_impressions


Name	Consent form impressions
Description	Times a visitor is served a consent form.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_ab_testing_personalization


Name	Consents to A/B testing and personalization
Description	Times a visitor agreed to A/B testing and personalization.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_analytics


Name	Consents to analytics
Description	Times a visitor agreed to analytics.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_any


Name	Any consents
Description	Times a visitor accepted one or more consent types, but not all.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_changed


Name	Changed consents
Description	Times a visitor changed their consent.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_conversion_tracking


Name	Consents to conversion tracking
Description	Times a visitor agreed to conversion tracking.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_custom_1


Name	Custom consents
Description	Times a visitor agreed to custom consent.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_first


Name	First consents
Description	Times a visitor gave their first consent.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_full


Name	Full consents
Description	Times a visitor accepted all consent types.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_marketing_automation


Name	Consents to marketing automation
Description	Times a visitor agreed to marketing automation.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_no_decision


Name	No decisions
Description	Times a visitor ignored the consent form without making any decision.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_none


Name	No consents
Description	Times a visitor didn't consent to anything.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_remarketing


Name	Consents to remarketing
Description	Times a visitor agreed to remarketing.
Scopes	event, product
Availability	Real-time, Query API
Type	int

consents_user_feedback


Name	Consents to user feedback
Description	Times a visitor agreed to user feedback.
Scopes	event, product
Availability	Real-time, Query API
Type	int

content_impressions


Name	Content impressions
Description	The number of times a content block was displayed to visitors.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

content_interaction_rate


Name	Content interaction rate
Description	The percentage of visitors who interacted with displayed content. Content interaction rate = (Content interactions / Content impressions) * 100%.
Scopes	event, product, session
Availability	Real-time, Query API
Type	float

content_interactions


Name	Content interactions
Description	The number of times visitors interacted with a content block, for example, clicked an element in a content block.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

custom_events


Name	Custom events
Description	The number of tracked custom events.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

downloads


Name	Downloads
Description	The number of clicks on links to downloadable files.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

ecommerce_abandoned_carts


Name	Abandoned carts
Description	The total number of abandoned carts. An abandoned cart happens when a shopper places products in a cart but doesn't complete a purchase.
Scopes	event, product, session
Availability	Query API
Type	int

ecommerce_conversion_rate


Name	Order rate
Description	The percentage of sessions during which shoppers completed their orders. Order conversion rate = Sessions with order / Sessions * 100%.
Scopes	event, product, session
Availability	Query API
Type	float

ecommerce_conversions


Name	Orders
Description	The total number of orders placed in your online store. An order is placed when a shopper completes the checkout process and pays for the product.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

entries


Name	Entries
Description	The number of page views for a page that was the first during a session.
Scopes	event, product, session
Availability	Query API
Type	int

entry_rate


Name	Entry rate
Description	The percentage of sessions that started on a selected page. It works only with these dimensions: page URL, page title, session entry URL. Entry rate = (Entries / Sessions) * 100%.
Scopes	event, product, session
Availability	Query API
Type	float

events


Name	Events
Description	The number of events performed by visitors.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

events_per_session


Name	Events per session
Description	The average number of events in a session.
Scopes	event, product, session
Availability	Query API
Type	float

exit_rate


Name	Exit rate
Description	The percentage of sessions that finished on a selected page. Exit rate = (Exits / Sessions) * 100%.
Scopes	event, product, session
Availability	Query API
Type	float

exit_rate_events


Name	Exit rate (events)
Description	The percentage of sessions that finished on a selected event. Exit rate (events) = (Exits / Unique page views) * 100%.
Scopes	event, product, session
Availability	Query API
Type	float

exits


Name	Exits
Description	The number of page views for a page that was the last during a session.
Scopes	event, product, session
Availability	Query API
Type	int

goal_conversion_rate


Name	Goal conversion rate
Description	The percentage of sessions during which visitors completed a goal. Goal conversion rate = (Sessions with a completed goal / Sessions) * 100%.
Scopes	event, product, session
Availability	Query API
Type	float

goal_conversions


Name	Goal conversions
Description	The total number of completed goals, repeated goals included.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

order_to_detail_rate


Name	Order-to-detail rate
Description	The percentage counted as: Orders / Product detail views * 100%. This metric helps you gauge how product details affect product sales.
Scopes	event, product, session
Availability	Real-time, Query API
Type	float

outlinks


Name	Outlinks
Description	The number of clicks on links to external domains.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

page_views


Name	Page views
Description	The number of times a page was visited.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

product_detail_views


Name	Product detail views
Description	The number of times shoppers viewed the product detail page.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

returning_visitors_rate


Name	% of returning visitors
Description	The percentage of returning visitors.
Scopes	event, product, session
Availability	Query API
Type	float

searches


Name	Searches
Description	The number of searches on your site or app.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

sessions


Name	Sessions
Description	The number of sessions performed by visitors. A session starts with the first event and ends 30 minutes after the last event (after the session is over).
Scopes	event, product, session
Availability	Query API
Type	int

total_quantity

❗️
Deprecated
Use product_quantity with 'sum' transformation instead.


Name	Total quantity
Description	The total number of products in the cart.
Scopes	event, product
Availability	Query API
Type	int

unique_content_impressions


Name	Unique content impressions
Description	The number of times a content block was uniquely displayed to visitors. Each unique combination of a content name, piece, and target is counted once per session.
Scopes	event, product, session
Availability	Query API
Type	int

unique_content_interactions


Name	Unique content interactions
Description	The number of times visitors uniquely interacted with a content block, for example, clicked an element in a content block. Each unique combination of content name, piece, and target is counted once per session.
Scopes	event, product, session
Availability	Query API
Type	int

unique_custom_events


Name	Unique custom events
Description	The number of tracked unique custom events. Each unique combination of an event category, action, and name is counted once per session.
Scopes	event, product, session
Availability	Query API
Type	int

unique_downloads


Name	Unique downloads
Description	The number of unique clicks on links to downloadable files. When a visitor clicks the same link many times during a session, it will be counted only once.
Scopes	event, product, session
Availability	Query API
Type	int

unique_goal_conversions


Name	Unique goal conversions
Description	The number of uniquely completed goals. Repeated goals are counted only once per session.
Scopes	event, product, session
Availability	Query API
Type	int

unique_outlinks


Name	Unique outlinks
Description	The number of unique clicks on links to external domains. When a visitor clicks the same link many times during a session, it will be counted only once.
Scopes	event, product, session
Availability	Query API
Type	int

unique_page_views


Name	Unique page views
Description	The number of times a page was uniquely visited. If a visitor views a page several times during one session, it will be counted only once.
Scopes	event, product, session
Availability	Query API
Type	int

unique_purchases

❗️
Deprecated
Use ecommerce_conversions instead.


Name	Unique purchases
Description	The number of the product purchases (orders with the product added to the cart).
Scopes	event, product
Availability	Query API
Type	int

unique_searches


Name	Unique searches
Description	The number of unique searches on your site or app. Each unique combination of a search keyword and category is counted once per session.
Scopes	event, product, session
Availability	Query API
Type	int

users


Name	Users
Description	The number of visitors with the User ID.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

visitor_ips


Name	Visitor IPs
Description	The number of unique IP addresses with the IPv4 protocol.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

visitors


Name	Visitors
Description	The number of unique visitors. Every visitor is counted once, even if they visit the site or app many times in a given date range.
Scopes	event, product, session
Availability	Real-time, Query API
Type	int

Dimensions

Here’s a list of core dimensions that you can use in API calls.

app_currency


Name	Currency (site or app)
Description	The currency set in the site or app settings at the time the event was tracked, used during data processing.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(3)
Nullable	false
Notes	app_currency.json

app_currency_conversion_rate


Name	Currency conversion rate
Description	The exchange rate used for currency conversion.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

browser_engine


Name	Browser engine
Description	The name of the visitor’s browser engine.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

browser_fingerprint


Name	Browser fingerprint
Scopes	event, product, session
Availability	Raw data API
Type	int
Database type	uint64
Nullable	false

browser_language_iso639


Name	Browser language
Description	The language of the visitor’s browser.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(2)
Nullable	true
Notes	browser_language_iso639.json

browser_name


Name	Browser name
Description	The name of the visitor’s browser.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(3)
Nullable	true
Notes	browser_name.json

browser_version


Name	Browser version
Description	The version of the visitor’s browser.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

campaign_content


Name	Campaign content
Description	The content of an online campaign taken from utm_content.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

campaign_gclid


Name	Gclid
Description	Google Click ID which is assigned to the click on the ad and passed to the landing page.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	true

campaign_id


Name	Campaign ID
Description	The ID of an online campaign taken from utm_id.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

campaign_name


Name	Campaign name
Description	The name of an online campaign taken from utm_campaign.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

consent_action


Name	Consent action
Description	When consent was given by the visitor: for the first time or changed later on.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	true
Notes	consent_action.json

consent_form_button


Name	Consent form button
Description	A button on your consent form: agree all, reject all, save choices or close.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	true
Notes	consent_form_button.json

consent_scope


Name	Consent scope
Description	What consent was given by the visitor: full, any or none.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	true
Notes	consent_scope.json

consent_source


Name	Consent source
Description	Where visitors clicked to consent or not: a popup or bottom bar, reminder, privacy settings on a page.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	true
Notes	consent_source.json

consent_type_ab_testing_personalization


Name	Consent to A/B testing and personalization
Description	A visitor consents or not to A/B testing and personalization.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	true

consent_type_analytics


Name	Consent to analytics
Description	A visitor consents or not to analytics.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	true

consent_type_conversion_tracking


Name	Consent to conversion tracking
Description	A visitor consents or not to conversion tracking.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	true

consent_type_custom_1


Name	Custom consent
Description	A visitor consents or not to the custom consent type.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	true

consent_type_marketing_automation


Name	Consent to marketing automation
Description	A visitor consents or not to marketing automation.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	true

consent_type_remarketing


Name	Consent to remarketing
Description	A visitor consents or not to remarketing.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	true

consent_type_user_feedback


Name	Consent to user feedback
Description	A visitor consents or not to user feedback.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	true

content_name


Name	Content name
Description	The name of the tracked content block.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

content_piece


Name	Content piece
Description	The piece of the tracked content block.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

content_target


Name	Content target
Description	The target of the tracked content block.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

cookie_id


Name	Cookie ID
Description	A unique identifier of the browser.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	hex
Database type	uint64
Nullable	false

currency_conversion_rates_date


Name	Currency conversion date
Description	The date of the exchange rate used for currency conversion.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	date
Database type	date
Nullable	true

custom_event_action


Name	Custom event action
Description	The action of the custom event.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

custom_event_category


Name	Custom event category
Description	The category of the custom event.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

custom_event_name


Name	Custom event name
Description	The name of the custom event.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

custom_event_value


Name	Custom event value
Description	The value of the custom event.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

device_brand


Name	Device brand
Description	The brand of the visitor’s device.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(3)
Nullable	true
Notes	device_brand.json

device_model


Name	Device model
Description	The model of visitor’s device.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

device_type


Name	Device type
Description	The type of the visitor’s device.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	true
Notes	device_type.json

domain_lookup_time


Name	Domain lookup time
Description	The time taken to resolve the server’s IP address.
Scopes	event, product
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	true
Notes	in milliseconds

download_url


Name	Download URL
Description	The URL of the downloadable file clicked by the visitor.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_dimension_1


Name	Event custom dimension 1
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_dimension_2


Name	Event custom dimension 2
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_dimension_3


Name	Event custom dimension 3
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_dimension_4


Name	Event custom dimension 4
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_dimension_5


Name	Event custom dimension 5
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_dimension_*


Name	Event custom dimension *
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false
Notes	read more about slots

event_custom_variable_key_1


Name	Event custom variable key 1
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_key_2


Name	Event custom variable key 2
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_key_3


Name	Event custom variable key 3
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_key_4


Name	Event custom variable key 4
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_key_5


Name	Event custom variable key 5
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_key_*


Name	Event custom variable key *
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false
Notes	read more about slots

event_custom_variable_value_1


Name	Event custom variable value 1
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_value_2


Name	Event custom variable value 2
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_value_3


Name	Event custom variable value 3
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_value_4


Name	Event custom variable value 4
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_value_5


Name	Event custom variable value 5
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_custom_variable_value_*


Name	Event custom variable value *
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false
Notes	read more about slots

event_id


Name	Event ID
Scopes	event, product
Availability	Real-time, Raw data API
Type	int
Database type	uint64
Nullable	false

event_index


Name	Event index
Scopes	event, product
Availability	Raw data API
Type	int
Database type	uint16
Nullable	false

event_title


Name	Page title
Description	The title of the page on which an event took place.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

event_type


Name	Event type
Description	The type of event such as a page view, download, outlink, performed by a visitor.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	false
Notes	event_type.json

event_url


Name	Page URL
Description	The URL of the page on which an event took place.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

goal_id

❗️
Deprecated
Removed, to identify Goals, use goal_uuid


Name	Goal name
Description	The name of the goal.
Scopes	event, product
Availability	Query API, Raw data API
Type	[int, str]
Database type	int32
Nullable	true

goal_revenue


Name	Goal revenue
Description	The revenue generated by a goal in the local currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

goal_revenue_app_currency


Name	Goal revenue (converted)
Description	The revenue generated by a goal, converted to the site or app currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

goal_revenue_base_currency


Name	Goal revenue (USD)
Description	The revenue generated by a goal, converted to the base currency (USD).
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

goal_uuid


Name	Goal name
Description	The name of the goal.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(16)
Nullable	true
Notes	goal UUID from Analytics

google_ads_currency


Name	Currency (Google Ads)
Description	The currency set in your Google Ads account settings. It's imported with other Google Ads data.
Scopes	event, product
Availability	Query API, Raw data API
Type	[str, str]
Database type	not applicable
Nullable	false
Notes	google_ads_currency.json

ipv4_address


Name	IPv4 address
Description	IPv4 address of a visitor. For filtering and segmenting purpose only.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	ipv4
Database type	not applicable
Nullable	true

ipv6_address


Name	IPv6 address
Description	IPv6 address of a visitor. For filtering and segmenting purpose only.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	ipv6
Database type	not applicable
Nullable	true

is_bounce


Name	Bounced session
Description	A bounced or non-bounced session. Bounce is when a visitor viewed an entry page but didn’t continue to another page view, goal conversion or order.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

is_entry


Name	Entry view
Scopes	event, product
Availability	Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

is_exit


Name	Exit view
Scopes	event, product
Availability	Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

item_count

❗️
Deprecated
Use product_count instead.


Name	Unique item count
Description	The number of unique items in an order or an abandoned basket.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint16
Nullable	true

keyword


Name	Keyword
Description	The keyword that a visitor used in a search engine or a keyword added as a campaign parameter.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

local_hour


Name	Local time (hour)
Description	The time of the event in the visitor's time zone.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	int
Database type	not applicable
Nullable	false

location_city_name


Name	City
Description	The city from which a visitor entered your site or app.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[int, str]
Database type	string
Nullable	true
Notes	unique identifiers as specified by GeoNames

location_continent_iso_code


Name	Continent
Description	The continent from which a visitor entered your site or app.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(2)
Nullable	true
Notes	location_continent_iso_code.json

location_country_name


Name	Country
Description	The country from which a visitor entered your site or app.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string
Nullable	true
Notes	ISO 3166-2 codes (e.g. “PL”)

location_latitude


Name	Latitude
Description	Geographic latitude at which a visitor entered your site or app.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

location_longitude


Name	Longitude
Description	Geographic longitude at which a visitor entered your site or app.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

location_metro_code

❗️
Deprecated
Removed, available only in outdated reports.


Name	Designated market area
Description	A media region where people receive similar content on TV, radio, newspaper, and internet.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(3)
Nullable	true
Notes	location_metro_code.json

location_organization


Name	Organization
Description	The name of the visitor’s organization, such as a business, educational, government unit. The organization is a company to which the internet service provider has sublet the IP address range. When an organization is not identified, this dimension contains the name of the internet service provider instead of the name of the business.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

location_provider


Name	Provider
Description	The name of the visitor’s internet service provider.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

location_subdivision_1_name


Name	Subdivision
Description	The region, state, province, and the like from which a visitor entered your site or app. It's the principal subdivision coded in ISO-3166.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string
Nullable	true
Notes	ISO 3166-2 codes (e.g. “PL-DS”)

location_subdivision_2_name


Name	Subdivision 2
Description	The region, state, province, and the like from which a visitor entered your site or app. It's the secondary subdivision coded in ISO-3166.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string
Nullable	true
Notes	ISO 3166-2 codes (e.g. “ES-M”)

lost_revenue


Name	Abandoned cart value
Description	The total value of abandoned carts in the local currency, excluding discounts, shipping, and taxes. Abandoned carts happen when shoppers add items to their carts but leave without completing the purchase.
Scopes	event, product
Availability	Query API, Raw data API
Type	float
Database type	float64
Nullable	true

lost_revenue_app_currency


Name	Abandoned cart value (converted)
Description	The total value of abandoned carts, excluding discounts, shipping, and taxes, converted to the site or app currency. Abandoned carts happen when shoppers add items to their carts but leave without completing the purchase.
Scopes	event, product
Availability	Query API, Raw data API
Type	float
Database type	float64
Nullable	true

lost_revenue_base_currency


Name	Abandoned cart value (USD)
Description	The total value of abandoned carts, excluding discounts, shipping, and taxes, converted to the base currency (USD). Abandoned carts happen when shoppers add items to their carts but leave without completing the purchase.
Scopes	event, product
Availability	Query API, Raw data API
Type	float
Database type	float64
Nullable	true

medium


Name	Medium
Description	The category of the source such as organic (unpaid search in the search engine), cpc (paid search in the search engine), referral (web referral), email (email campaign), and the like.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str_nocase
Database type	string
Nullable	false

next_event_title


Name	Next page view title
Description	The title of the page that was viewed next.
Scopes	event, product
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

next_event_url


Name	Next page view URL
Description	The URL of the page that was viewed next.
Scopes	event, product
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

operating_system


Name	Operating system
Description	The name of the visitor’s operating system.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(3)
Nullable	true
Notes	operating_system.json

operating_system_version


Name	Operating system version
Description	The version of the visitor’s operating system.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

order_id


Name	Order ID
Description	The unique identifier (ID) of the order.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

outlink_url


Name	Outlink URL
Description	The URL of the external domain that was clicked by the visitor.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

page_generation_time


Name	Page generation time
Description	The page loading time on the visitor’s device.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true
Notes	in milliseconds

page_rendering_time


Name	Page rendering time
Description	The time taken to create the render tree, layout, and finally draw the website in the browser.
Scopes	event, product
Availability	Query API, Raw data API
Type	int
Database type	uint32
Nullable	true
Notes	in milliseconds

page_view_index


Name	Page view index
Scopes	event, product
Availability	Raw data API
Type	int
Database type	uint16
Nullable	true

plugin_cookie


Name	Cookie support
Description	An enabled or disabled support for cookies in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_director


Name	Director plugin
Description	An enabled or disabled Director plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_flash


Name	Flash plugin
Description	An enabled or disabled flash plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_gears


Name	Gears plugin
Description	An enabled or disabled Gears plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_java


Name	Java plugin
Description	An enabled or disabled Java plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_pdf


Name	PDF plugin
Description	An enabled or disabled PDF plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_quicktime


Name	QuickTime plugin
Description	An enabled or disabled QuickTime plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_realplayer


Name	RealPlayer plugin
Description	An enabled or disabled RealPlayer plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_silverlight


Name	Silverlight plugin
Description	An enabled or disabled Silverlight plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

plugin_windowsmedia


Name	Windows media player plugin
Description	An enabled or disabled Windows Media Player plugin in the visitor’s browser.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int(0,1)
Database type	uint8
Nullable	false

previous_event_title


Name	Previous page view title
Description	The title of the page that was viewed previously.
Scopes	event, product
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

previous_event_url


Name	Previous page view URL
Description	The URL of the page that was viewed previously.
Scopes	event, product
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

product_brand


Name	Product brand
Description	The brand of the product in your online store.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_category


Name	Product category
Description	A category that includes all product category levels in your online store. Example: "Clothes/Men/T-shirts".
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_category1


Name	Product category (Level 1)
Description	The first-level category of the product in your online store.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_category2


Name	Product category (Level 2)
Description	The second-level category of the product in your online store.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_category3


Name	Product category (Level 3)
Description	The third-level category of the product in your online store.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_category4


Name	Product category (Level 4)
Description	The fourth-level category of the product in your online store.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_category5


Name	Product category (Level 5)
Description	The fifth-level category of the product in your online store.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_count


Name	Unique product count
Description	The number of unique products. When a customer orders two iPhone 14s, the product quantity will be 2, and the unique product count will be 1.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint16
Nullable	true

product_dimension1


Name	Product dimension 1
Scopes	product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	array of string
Nullable	false

product_dimension2


Name	Product dimension 2
Scopes	product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	array of string
Nullable	false

product_dimension3


Name	Product dimension 3
Scopes	product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	array of string
Nullable	false

product_dimension4


Name	Product dimension 4
Scopes	product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	array of string
Nullable	false

product_dimension5


Name	Product dimension 5
Scopes	product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	array of string
Nullable	false

product_dimension*


Name	Product dimension *
Scopes	product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	array of string
Nullable	false
Notes	read more about slots

product_name


Name	Product name
Description	The name of the product in your online store.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_price


Name	Product price
Description	The price of the product in the local currency.
Scopes	product
Availability	Real-time, Query API
Type	float
Database type	array of float32
Nullable	false

product_price_app_currency


Name	Product price (converted)
Description	The price of the product, converted to the site or app currency.
Scopes	product
Availability	Real-time, Query API
Type	float
Database type	array of nullable
Nullable	false

product_price_base_currency


Name	Product price (USD)
Description	The price of the product, converted to the base currency (USD).
Scopes	product
Availability	Real-time, Query API
Type	float
Database type	array of nullable
Nullable	false

product_quantity


Name	Product quantity
Description	The total number of products. When a customer orders two iPhone 14s, the product quantity will be 2, and the unique product count will be 1.
Scopes	product
Availability	Real-time, Query API
Type	int
Database type	array of uint32
Nullable	false

product_revenue


Name	Product revenue
Description	The value calculated by multiplying the product price by the product quantity in the local currency.
Scopes	product
Availability	Real-time, Query API
Type	float
Database type	array of float32
Nullable	false

product_revenue_app_currency


Name	Product revenue (converted)
Description	The value calculated by multiplying the product price by the product quantity, converted to the site or app currency.
Scopes	product
Availability	Real-time, Query API
Type	float
Database type	array of nullable
Nullable	false

product_revenue_base_currency


Name	Product revenue (USD)
Description	The value calculated by multiplying the product price by the product quantity, converted to the base currency (USD).
Scopes	product
Availability	Real-time, Query API
Type	float
Database type	array of nullable
Nullable	false

product_sku


Name	Product SKU
Description	The stock-keeping unit of the product in your online store.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

product_variant


Name	Product variant
Description	The variant of the product in your online store. Example: color and size.
Scopes	product
Availability	Real-time, Query API
Type	str
Database type	array of string
Nullable	false

products.brand


Name	Product brand (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.category


Name	Product category (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.category1


Name	Product category 1 (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.category2


Name	Product category 2 (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.category3


Name	Product category 3 (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.category4


Name	Product category 4 (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.category5


Name	Product category 5 (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.dimension1


Name	Product dimension 1 (array)
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	array
Database type	array of string
Nullable	false

products.dimension2


Name	Product dimension 2 (array)
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	array
Database type	array of string
Nullable	false

products.dimension3


Name	Product dimension 3 (array)
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	array
Database type	array of string
Nullable	false

products.dimension4


Name	Product dimension 4 (array)
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	array
Database type	array of string
Nullable	false

products.dimension5


Name	Product dimension 5 (array)
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	array
Database type	array of string
Nullable	false

products.dimension*


Name	Product dimension * (array)
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	array
Database type	array of string
Nullable	false
Notes	read more about slots

products.name


Name	Product name (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.price


Name	Product price (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of float32
Nullable	false

products.price_app_currency


Name	Product price (array, converted)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of nullable
Nullable	false

products.price_base_currency


Name	Product price (array, USD)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of nullable
Nullable	false

products.quantity


Name	Product quantity (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of uint32
Nullable	false

products.revenue


Name	Product revenue (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of float32
Nullable	false

products.revenue_app_currency


Name	Product revenue (array, converted)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of nullable
Nullable	false

products.revenue_base_currency


Name	Product revenue (array, USD)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of nullable
Nullable	false

products.sku


Name	Product SKU (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

products.variant


Name	Product variant (array)
Scopes	event, product
Availability	Real-time, Raw data API
Type	array
Database type	array of string
Nullable	false

redirections_time


Name	Time of redirections
Description	The time of one or more redirects that occurred. Transactions that don’t have any HTTP redirections are not included in calculating the average value.
Scopes	event, product
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	true
Notes	in milliseconds

referrer_type


Name	Channel
Description	The channel of the incoming traffic. The channels are: direct entry, search engine, website, and campaign.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	false
Notes	referrer_type.json

referrer_url


Name	Referrer URL
Description	The URL of the page that referred a visitor to your site or app.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

resolution


Name	Resolution
Description	The number of horizontal and vertical pixels on the visitor’s device.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	true

resolution_height


Name	Resolution height
Description	The number of horizontal pixels on the visitor’s device.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint16
Nullable	true

resolution_width


Name	Resolution width
Description	The number of vertical pixels on the visitor’s device.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint16
Nullable	true

revenue


Name	Revenue
Description	The total order value in the local currency, including subtotal, tax, shipping and discounts.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_app_currency


Name	Revenue (converted)
Description	The total order value, including subtotal, tax, shipping and discounts, converted to the site or app currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_base_currency


Name	Revenue (USD)
Description	The total order value, including subtotal, tax, shipping and discounts, converted to the base currency (USD).
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_discount


Name	Discount
Description	The total discount value applied to the order in the local currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_discount_app_currency


Name	Discount (converted)
Description	The total discount value applied to the order, converted to the site or app currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_discount_base_currency


Name	Discount (USD)
Description	The total discount value applied to the order, converted to the base currency (USD).
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_shipping


Name	Shipping
Description	The total shipping cost of the order in the local currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_shipping_app_currency


Name	Shipping (converted)
Description	The total shipping cost of the order, converted to the site or app currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_shipping_base_currency


Name	Shipping (USD)
Description	The total shipping cost of the order, converted to the base currency (USD).
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_subtotal


Name	Subtotal
Description	The total order value in the local currency, excluding shipping and discounts.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_subtotal_app_currency


Name	Subtotal (converted)
Description	The total order value, excluding shipping and discounts, converted to the site or app currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_subtotal_base_currency


Name	Subtotal (USD)
Description	The total order value, excluding shipping and discounts, converted to the base currency (USD).
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_tax


Name	Tax
Description	The total tax amount of the order in the local currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_tax_app_currency


Name	Tax (converted)
Description	The total tax amount of the order, converted to the site or app currency.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

revenue_tax_base_currency


Name	Tax (USD)
Description	The total tax amount of the order, converted to the base currency (USD).
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	float
Database type	float64
Nullable	true

search_category


Name	Search category
Description	The category of the keyword used in the search engine on your site or app.
Scopes	event, product
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

search_keyword


Name	Search keyword
Description	The keyword used in the search engine on your site or app. It works only with these metrics: searches, unique searches. .
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

search_results_count


Name	Search results count
Description	The count of searches on your site or app.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint32
Nullable	true

server_connection_time


Name	Server connection time
Description	The time taken to establish a connection with the web server.
Scopes	event, product
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	true
Notes	in milliseconds

server_response_time


Name	Server response time
Description	The time taken to receive the first byte of response from the server to the browser’s request.
Scopes	event, product
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	true
Notes	in milliseconds

session_custom_dimension_1


Name	Session custom dimension 1
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_dimension_2


Name	Session custom dimension 2
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_dimension_3


Name	Session custom dimension 3
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_dimension_4


Name	Session custom dimension 4
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_dimension_5


Name	Session custom dimension 5
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_dimension_*


Name	Session custom dimension *
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false
Notes	read more about slots

session_custom_variable_key_1


Name	Session custom variable key 1
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_key_2


Name	Session custom variable key 2
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_key_3


Name	Session custom variable key 3
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_key_4


Name	Session custom variable key 4
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_key_5


Name	Session custom variable key 5
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_key_*


Name	Session custom variable key *
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false
Notes	read more about slots

session_custom_variable_value_1


Name	Session custom variable value 1
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_value_2


Name	Session custom variable value 2
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_value_3


Name	Session custom variable value 3
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_value_4


Name	Session custom variable value 4
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_value_5


Name	Session custom variable value 5
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_custom_variable_value_*


Name	Session custom variable value *
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false
Notes	read more about slots

session_ecommerce_status


Name	Shopping stage
Description	A stage that a shopper completed during a session. The stages are: No shopping activity, Ordered, Abandoned cart, Ordered and abandoned cart.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	false
Notes	session_ecommerce_status.json

session_entry_title


Name	Session entry title
Description	The title of the first visited page during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_entry_url


Name	Session entry URL
Description	The URL of the first visited page during the session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_exit_title


Name	Session exit title
Description	The page title of the last visited page during the session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_exit_url


Name	Session exit URL
Description	The URL of the last visited page during the session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_goal_uuids


Name	Session goals
Description	List of goals on which user converted during the session. It can be used only for filtering purposes.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	array(uuid)
Database type	array of string(16)
Nullable	false

session_goals


Name	Session goals
Description	List of goals on which user converted during the session. It can be used only for filtering purposes.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	array
Database type	array of int32
Nullable	false

session_id


Name	Session ID
Scopes	event, product, session
Availability	Raw data API
Type	int
Database type	uint64
Nullable	false

session_second_title


Name	Session second title
Description	The title of the second page visited by a visitor during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_second_url


Name	Session second URL
Description	The URL of the second page visited by a visitor during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	str
Database type	string
Nullable	false

session_total_abandoned_carts


Name	Abandoned carts in session
Description	The number of abandoned carts during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_cart_additions


Name	Adds to cart in session
Description	The number of adds to cart during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_cart_removals


Name	Removes from cart in session
Description	The number of removes from cart during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_content_impressions


Name	Content impressions in session
Description	The number of content impressions during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_content_interactions


Name	Content interactions in session
Description	The number of content interactions during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_custom_events


Name	Custom events in session
Description	The number of custom events during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_downloads


Name	Downloads in session
Description	The number of download events during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_ecommerce_conversions


Name	Orders in session
Description	The number of orders placed during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_events


Name	Events in session
Description	The number of events during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_goal_conversions


Name	Goal conversions in session
Description	The number of completed goals during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_outlinks


Name	Outlinks in session
Description	The number of clicked outlinks during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_page_views


Name	Page views in session
Description	The number of page views during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_product_detail_views


Name	Product detail views in session
Description	The number of product detail views during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_site_searches


Name	Site searches in session
Description	The number of searches on your site or app during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_total_time


Name	Session time
Description	The duration of a session measured from the first to last event during a visit.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint32
Nullable	false
Notes	in seconds

session_unique_content_impressions


Name	Unique content impressions in session
Description	The number of unique content impressions during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_unique_content_interactions


Name	Unique content interactions in session
Description	The number of unique content interactions during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_unique_custom_events


Name	Unique custom events in session
Description	The number of unique custom events during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_unique_downloads


Name	Unique downloads in session
Description	The number of unique download events during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_unique_outlinks


Name	Unique outlinks in session
Description	The number of uniquely clicked outlinks during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_unique_page_views


Name	Unique page views in session
Description	The number of unique page views during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

session_unique_searches


Name	Unique site searches in session
Description	The number of unique searches on your site or app during a session.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

source


Name	Source
Description	The origin of the incoming traffic such as direct, a search engine (for example, google) or a domain (example.com).
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str_nocase
Database type	string
Nullable	false

source_medium


Name	Source / medium
Description	A dimension that combines two dimensions: source and medium. Source is the origin of the incoming traffic. Medium is the category of the source.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str_nocase
Database type	string
Nullable	false

time_on_page


Name	Time on page
Description	The amount of time the visitor spent on the page.
Scopes	event, product
Availability	Query API, Raw data API
Type	int
Database type	uint32
Nullable	true
Notes	in seconds

timestamp


Name	Date
Description	Day and time of the event in the site’s time zone.
Scopes	event, product, session
Availability	Real-time, Query API
Type	date
Database type	not applicable
Nullable	false
Notes	server time in the website’s time zone

timing_dom_interactive


Name	Time until DOM is ready
Description	The time taken to process the page document HTML and CSS.
Scopes	event, product
Availability	Query API, Raw data API
Type	int
Database type	uint32
Nullable	true
Notes	in milliseconds

timing_event_end


Name	Time to interact
Description	The time from the user request (for example, click a link or submission of the URL in the browser) to the point when page content and main scripts are loaded and the user can interact with the page. It’s the time of the transaction between the client and the server.
Scopes	event, product
Availability	Query API, Raw data API
Type	int
Database type	uint32
Nullable	true

tracked_currency


Name	Currency (event)
Description	The local currency tracked with an event.
Scopes	event, product
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	string(3)
Nullable	false
Notes	tracked_currency.json

user_id


Name	User ID
Description	The ID of the visitor coming from an external source.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	str
Database type	string
Nullable	false

visitor_days_since_first_session


Name	Days since first session
Description	The number of days since the visitor had their first session.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint16
Nullable	true

visitor_days_since_last_session


Name	Days since last session
Description	The number of days since the visitor had their last session.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint16
Nullable	true

visitor_days_since_order


Name	Days since last order
Description	The number of days since the visitor made their last order.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint16
Nullable	true

visitor_id


Name	Visitor ID
Description	A unique identifier of the visitor.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	hex
Database type	uint64
Nullable	false

visitor_returning


Name	Returning visitor
Description	A new or returning visitor.
Scopes	event, product, session
Availability	Query API, Raw data API
Type	[int, str]
Database type	uint8
Nullable	false
Notes	visitor_returning.json

visitor_session_number


Name	Session number
Description	The number of the session counted for a visitor. Each time a visitor starts a session, a session counter increments for that visitor.
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	int
Database type	uint16
Nullable	false

website_name


Name	Site or app name
Scopes	event, product, session
Availability	Real-time, Query API, Raw data API
Type	[str, str]
Database type	not applicable
Nullable	false
Notes	website UUID

Note:

• If you make a call that includes one or more columns with the event scope, the entire calculation will be based on events rather than sessions. This might affect some custom metrics, such as average session time.

• The Database type column displays the source type associated with each dimension. For the enum dimensions, it displays the ID type. For the not applicable source type, this column represents a dynamic dimension.

• The number of available custom slots (dimensions and variables) depends on your organization’s configuration. The standard numbers are 200 for session or event custom dimensions, 10 for session or event custom variables and 20 for product custom dimensions.

Transformation: dimension to metric

Here’s a list of transformations that you can use.

Transformation name	Transformation ID	Source types	Result type
Unique count	unique_count	int, str	int
Min	min	float, int	(as source)
Max	max	float, int	(as source)
Average	average	float, int	float
Median	median	float, int	(as source)
Sum	sum	float, int	(as source)

Transformation: dimension to dimension

Here’s a list of transformations that you can use.

Transformation name	Transformation ID	Source types	Result type
Date to day	to_date	date, datetime	date
Date to start of hour	to_start_of_hour	datetime	datetime
Date to start of week	to_start_of_week	date, datetime	date
Date to start of month	to_start_of_month	date, datetime	date
Date to start of quarter	to_start_of_quarter	date, datetime	date
Date to start of year	to_start_of_year	date, datetime	date
Date to hour of day	to_hour_of_day	datetime	int
Date to day of week	to_day_of_week	date, datetime	int
Date to month number	to_month_number	date, datetime	int
Date to start of minute	to_start_of_minute	datetime	datetime
Date to start of five minutes	to_start_of_five_minutes	datetime	datetime
Date to start of ten minutes	to_start_of_ten_minutes	datetime	datetime
Lowercase	lower	str	str
Url to path	to_path	str	str
Url to domain	to_domain	str	str
Url strip query string	strip_qs	str	str

Metrics

abandoned_cart_rate

bounce_rate

bounce_rate_events

bounces

cart_additions

cart_removals

cart_to_detail_rate

consent_form_clicks

consent_form_impressions

consents_ab_testing_personalization

consents_analytics

consents_any

consents_changed

consents_conversion_tracking

consents_custom_1

consents_first

consents_full

consents_marketing_automation

consents_no_decision

consents_none

consents_remarketing

consents_user_feedback

content_impressions

content_interaction_rate

content_interactions

custom_events

downloads

ecommerce_abandoned_carts

ecommerce_conversion_rate

ecommerce_conversions

entries

entry_rate

events

events_per_session

exit_rate

exit_rate_events

exits

goal_conversion_rate

goal_conversions

order_to_detail_rate

outlinks

page_views

product_detail_views

returning_visitors_rate

searches

sessions

total_quantity

❗️Deprecated

unique_content_impressions

unique_content_interactions

unique_custom_events

unique_downloads

unique_goal_conversions

unique_outlinks

unique_page_views

unique_purchases

❗️Deprecated

unique_searches

users

visitor_ips

visitors

Dimensions

app_currency

app_currency_conversion_rate

browser_engine

browser_fingerprint

browser_language_iso639

browser_name

browser_version

campaign_content

campaign_gclid

campaign_id

campaign_name

consent_action

consent_form_button

consent_scope

consent_source

consent_type_ab_testing_personalization

consent_type_analytics

❗️
Deprecated

❗️
Deprecated

❗️
Deprecated

❗️
Deprecated