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

NameCart abandonment rate
Scopesevent, product, session
AvailabilityQuery API
Typefloat

bounce_rate

NameBounce rate
Scopesevent, product, session
AvailabilityQuery API
Typefloat

bounce_rate_events

NamePage bounce rate
Scopesevent, product, session
AvailabilityQuery API
Typefloat

bounces

NameBounces
Scopesevent, product, session
AvailabilityQuery API
Typeint

cart_additions

NameAdds to cart
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

cart_removals

NameRemoves from cart
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

cart_to_detail_rate

NameCart-to-detail rate
Scopesevent, product, session
AvailabilityReal-time, Query API
Typefloat

consent_form_clicks

NameConsent form clicks
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consent_form_impressions

NameConsent form impressions
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_ab_testing_personalization

NameConsents to A/B testing and personalization
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_analytics

NameConsents to analytics
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_any

NameAny consents
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_changed

NameChanged consents
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_conversion_tracking

NameConsents to conversion tracking
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_custom_1

NameCustom consents
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_first

NameFirst consents
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_full

NameFull consents
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_marketing_automation

NameConsents to marketing automation
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_no_decision

NameNo decisions
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_none

NameNo consents
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_remarketing

NameConsents to remarketing
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

consents_user_feedback

NameConsents to user feedback
Scopesevent, product
AvailabilityReal-time, Query API
Typeint

content_impressions

NameContent impressions
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

content_interaction_rate

NameContent interaction rate
Scopesevent, product, session
AvailabilityReal-time, Query API
Typefloat

content_interactions

NameContent interactions
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

custom_events

NameCustom events
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

downloads

NameDownloads
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

ecommerce_abandoned_carts

NameAbandoned carts
Scopesevent, product, session
AvailabilityQuery API
Typeint

ecommerce_conversion_rate

NameOrder rate
Scopesevent, product, session
AvailabilityQuery API
Typefloat

ecommerce_conversions

NameOrders
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

entries

NameEntries
Scopesevent, product, session
AvailabilityQuery API
Typeint

entry_rate

NameEntry rate
Scopesevent, product, session
AvailabilityQuery API
Typefloat

events

NameEvents
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

events_per_session

NameEvents per session
Scopesevent, product, session
AvailabilityQuery API
Typefloat

exit_rate

NameExit rate
Scopesevent, product, session
AvailabilityQuery API
Typefloat

exit_rate_events

NameExit rate (events)
Scopesevent, product, session
AvailabilityQuery API
Typefloat

exits

NameExits
Scopesevent, product, session
AvailabilityQuery API
Typeint

goal_conversion_rate

NameGoal conversion rate
Scopesevent, product, session
AvailabilityQuery API
Typefloat

goal_conversions

NameGoal conversions
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

order_to_detail_rate

NameOrder-to-detail rate
Scopesevent, product, session
AvailabilityReal-time, Query API
Typefloat

outlinks

NameOutlinks
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

page_views

NamePage views
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

product_detail_views

NameProduct detail views
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

returning_visitors_rate

Name% of returning visitors
Scopesevent, product, session
AvailabilityQuery API
Typefloat

searches

NameSearches
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

sessions

NameSessions
Scopesevent, product, session
AvailabilityQuery API
Typeint

total_quantity

❗️

Deprecated

Use product_quantity with 'sum' transformation instead.

NameTotal quantity
Scopesevent, product
AvailabilityQuery API
Typeint

unique_content_impressions

NameUnique content impressions
Scopesevent, product, session
AvailabilityQuery API
Typeint

unique_content_interactions

NameUnique content interactions
Scopesevent, product, session
AvailabilityQuery API
Typeint

unique_custom_events

NameUnique custom events
Scopesevent, product, session
AvailabilityQuery API
Typeint

unique_downloads

NameUnique downloads
Scopesevent, product, session
AvailabilityQuery API
Typeint

unique_goal_conversions

NameUnique goal conversions
Scopesevent, product, session
AvailabilityQuery API
Typeint

unique_outlinks

NameUnique outlinks
Scopesevent, product, session
AvailabilityQuery API
Typeint

unique_page_views

NameUnique page views
Scopesevent, product, session
AvailabilityQuery API
Typeint

unique_purchases

❗️

Deprecated

Use ecommerce_conversions instead.

NameUnique purchases
Scopesevent, product
AvailabilityQuery API
Typeint

unique_searches

NameUnique searches
Scopesevent, product, session
AvailabilityQuery API
Typeint

users

NameUsers
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

visitor_ips

NameVisitor IPs
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

visitors

NameVisitors
Scopesevent, product, session
AvailabilityReal-time, Query API
Typeint

Dimensions

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

browser_engine

NameBrowser engine
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

browser_fingerprint

NameBrowser fingerprint
Scopesevent, product, session
AvailabilityRaw data API
Typeint
Database typeuint64
Nullablefalse

browser_language_iso639

NameBrowser language
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(2)
Nullabletrue
Notesbrowser_language_iso639.json

browser_name

NameBrowser name
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(3)
Nullabletrue
Notesbrowser_name.json

browser_version

NameBrowser version
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

campaign_content

NameCampaign content
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

campaign_gclid

NameGclid
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullabletrue

campaign_id

NameCampaign ID
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

campaign_name

NameCampaign name
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

consent_action

NameConsent action
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullabletrue
Notesconsent_action.json

consent_form_button

NameConsent form button
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullabletrue
Notesconsent_form_button.json

consent_scope

NameConsent scope
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullabletrue
Notesconsent_scope.json

consent_source

NameConsent source
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullabletrue
Notesconsent_source.json

consent_type_ab_testing_personalization

NameConsent to A/B testing and personalization
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint(0,1)
Database typeuint8
Nullabletrue

consent_type_analytics

NameConsent to analytics
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint(0,1)
Database typeuint8
Nullabletrue

consent_type_conversion_tracking

NameConsent to conversion tracking
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint(0,1)
Database typeuint8
Nullabletrue

consent_type_custom_1

NameCustom consent
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint(0,1)
Database typeuint8
Nullabletrue

consent_type_marketing_automation

NameConsent to marketing automation
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint(0,1)
Database typeuint8
Nullabletrue

consent_type_remarketing

NameConsent to remarketing
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint(0,1)
Database typeuint8
Nullabletrue

consent_type_user_feedback

NameConsent to user feedback
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint(0,1)
Database typeuint8
Nullabletrue

content_name

NameContent name
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

content_piece

NameContent piece
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

content_target

NameContent target
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

cookie_id

NameCookie ID
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typehex
Database typeuint64
Nullablefalse

custom_event_action

NameCustom event action
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

custom_event_category

NameCustom event category
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

custom_event_name

NameCustom event name
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

custom_event_value

NameCustom event value
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

device_brand

NameDevice brand
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(3)
Nullabletrue
Notesdevice_brand.json

device_model

NameDevice model
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

device_type

NameDevice type
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullabletrue
Notesdevice_type.json

domain_lookup_time

NameDomain lookup time
Scopesevent, product
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullabletrue
Notesin milliseconds

download_url

NameDownload URL
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_dimension_1

NameEvent custom dimension 1
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_dimension_2

NameEvent custom dimension 2
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_dimension_3

NameEvent custom dimension 3
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_dimension_4

NameEvent custom dimension 4
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_dimension_5

NameEvent custom dimension 5
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_dimension_*

NameEvent custom dimension *
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse
Notesread more about slots

event_custom_variable_key_1

NameEvent custom variable key 1
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_key_2

NameEvent custom variable key 2
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_key_3

NameEvent custom variable key 3
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_key_4

NameEvent custom variable key 4
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_key_5

NameEvent custom variable key 5
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_key_*

NameEvent custom variable key *
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse
Notesread more about slots

event_custom_variable_value_1

NameEvent custom variable value 1
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_value_2

NameEvent custom variable value 2
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_value_3

NameEvent custom variable value 3
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_value_4

NameEvent custom variable value 4
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_value_5

NameEvent custom variable value 5
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_custom_variable_value_*

NameEvent custom variable value *
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse
Notesread more about slots

event_id

NameEvent ID
Scopesevent, product
AvailabilityReal-time, Raw data API
Typeint
Database typeuint64
Nullablefalse

event_index

NameEvent index
Scopesevent, product
AvailabilityRaw data API
Typeint
Database typeuint16
Nullablefalse

event_title

NamePage title
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

event_type

NameEvent type
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullablefalse
Notesevent_type.json

event_url

NamePage URL
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

goal_id

❗️

Deprecated

Removed, to identify Goals, use goal_uuid

NameGoal name
Scopesevent, product
AvailabilityQuery API, Raw data API
Type[int, str]
Database typeint32
Nullabletrue

goal_revenue

NameGoal revenue
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

goal_uuid

NameGoal name
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(16)
Nullabletrue
Notesgoal UUID from Analytics

ipv4_address

NameIPv4 address
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeipv4
Database typenot applicable
Nullabletrue

ipv6_address

NameIPv6 address
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeipv6
Database typenot applicable
Nullabletrue

is_bounce

NameBounced session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

is_entry

NameEntry view
Scopesevent, product
AvailabilityRaw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

is_exit

NameExit view
Scopesevent, product
AvailabilityRaw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

item_count

❗️

Deprecated

Use product_count instead.

NameUnique item count
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint16
Nullabletrue

keyword

NameKeyword
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

local_hour

NameLocal time (hour)
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typenot applicable
Nullablefalse

location_city_name

NameCity
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typestring
Nullabletrue
Notesunique identifiers as specified by GeoNames

location_continent_iso_code

NameContinent
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(2)
Nullabletrue
Noteslocation_continent_iso_code.json

location_country_name

NameCountry
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring
Nullabletrue
NotesISO 3166-2 codes (e.g. “PL”)

location_latitude

NameLatitude
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

location_longitude

NameLongitude
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

location_metro_code

❗️

Deprecated

Removed, available only in outdated reports.

NameDesignated market area
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(3)
Nullabletrue
Noteslocation_metro_code.json

location_organization

NameOrganization
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

location_provider

NameProvider
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

location_subdivision_1_name

NameSubdivision
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring
Nullabletrue
NotesISO 3166-2 codes (e.g. “PL-DS”)

location_subdivision_2_name

NameSubdivision 2
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring
Nullabletrue
NotesISO 3166-2 codes (e.g. “ES-M”)

lost_revenue

NameAbandoned cart value
Scopesevent, product
AvailabilityQuery API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

medium

NameMedium
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

next_event_title

NameNext page view title
Scopesevent, product
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

next_event_url

NameNext page view URL
Scopesevent, product
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

operating_system

NameOperating system
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(3)
Nullabletrue
Notesoperating_system.json

operating_system_version

NameOperating system version
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

order_id

NameOrder ID
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

outlink_url

NameOutlink URL
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

page_generation_time

NamePage generation time
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue
Notesin milliseconds

page_rendering_time

NamePage rendering time
Scopesevent, product
AvailabilityQuery API, Raw data API
Typeint
Database typeuint32
Nullabletrue
Notesin milliseconds

page_view_index

NamePage view index
Scopesevent, product
AvailabilityRaw data API
Typeint
Database typeuint16
Nullabletrue

plugin_cookie

NameCookie support
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_director

NameDirector plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_flash

NameFlash plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_gears

NameGears plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_java

NameJava plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_pdf

NamePDF plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_quicktime

NameQuickTime plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_realplayer

NameRealPlayer plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_silverlight

NameSilverlight plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

plugin_windowsmedia

NameWindows media player plugin
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint(0,1)
Database typeuint8
Nullablefalse

previous_event_title

NamePrevious page view title
Scopesevent, product
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

previous_event_url

NamePrevious page view URL
Scopesevent, product
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

product_brand

NameProduct brand
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_category

NameProduct category
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_category1

NameProduct category (Level 1)
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_category2

NameProduct category (Level 2)
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_category3

NameProduct category (Level 3)
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_category4

NameProduct category (Level 4)
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_category5

NameProduct category (Level 5)
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_count

NameUnique product count
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint16
Nullabletrue

product_dimension1

NameProduct dimension 1
Scopesproduct
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typearray of string
Nullablefalse

product_dimension2

NameProduct dimension 2
Scopesproduct
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typearray of string
Nullablefalse

product_dimension3

NameProduct dimension 3
Scopesproduct
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typearray of string
Nullablefalse

product_dimension4

NameProduct dimension 4
Scopesproduct
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typearray of string
Nullablefalse

product_dimension5

NameProduct dimension 5
Scopesproduct
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typearray of string
Nullablefalse

product_dimension*

NameProduct dimension *
Scopesproduct
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typearray of string
Nullablefalse
Notesread more about slots

product_name

NameProduct name
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_price

NameProduct price
Scopesproduct
AvailabilityReal-time, Query API
Typefloat
Database typearray of float32
Nullablefalse

product_quantity

NameProduct quantity
Scopesproduct
AvailabilityReal-time, Query API
Typeint
Database typearray of uint32
Nullablefalse

product_revenue

NameProduct revenue
Scopesproduct
AvailabilityReal-time, Query API
Typefloat
Database typearray of float32
Nullablefalse

product_sku

NameProduct SKU
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

product_variant

NameProduct variant
Scopesproduct
AvailabilityReal-time, Query API
Typestr
Database typearray of string
Nullablefalse

products.brand

NameProduct brand (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.category

NameProduct category (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.category1

NameProduct category 1 (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.category2

NameProduct category 2 (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.category3

NameProduct category 3 (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.category4

NameProduct category 4 (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.category5

NameProduct category 5 (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.dimension1

NameProduct dimension 1 (array)
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.dimension2

NameProduct dimension 2 (array)
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.dimension3

NameProduct dimension 3 (array)
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.dimension4

NameProduct dimension 4 (array)
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.dimension5

NameProduct dimension 5 (array)
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.dimension*

NameProduct dimension * (array)
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typearray
Database typearray of string
Nullablefalse
Notesread more about slots

products.name

NameProduct name (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.price

NameProduct price (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of float32
Nullablefalse

products.quantity

NameProduct quantity (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of uint32
Nullablefalse

products.revenue

NameProduct revenue (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of float32
Nullablefalse

products.sku

NameProduct SKU (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

products.variant

NameProduct variant (array)
Scopesevent, product
AvailabilityReal-time, Raw data API
Typearray
Database typearray of string
Nullablefalse

redirections_time

NameTime of redirections
Scopesevent, product
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullabletrue
Notesin milliseconds

referrer_type

NameChannel
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullablefalse
Notesreferrer_type.json

referrer_url

NameReferrer URL
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

resolution

NameResolution
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullabletrue

resolution_height

NameResolution height
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint16
Nullabletrue

resolution_width

NameResolution width
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint16
Nullabletrue

revenue

NameRevenue
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

revenue_discount

NameDiscount
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

revenue_shipping

NameShipping
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

revenue_subtotal

NameSubtotal
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

revenue_tax

NameTax
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typefloat
Database typefloat64
Nullabletrue

search_category

NameSearch category
Scopesevent, product
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

search_keyword

NameSearch keyword
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

search_results_count

NameSearch results count
Scopesevent, product
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint32
Nullabletrue

server_connection_time

NameServer connection time
Scopesevent, product
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullabletrue
Notesin milliseconds

server_response_time

NameServer response time
Scopesevent, product
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullabletrue
Notesin milliseconds

session_custom_dimension_1

NameSession custom dimension 1
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_dimension_2

NameSession custom dimension 2
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_dimension_3

NameSession custom dimension 3
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_dimension_4

NameSession custom dimension 4
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_dimension_5

NameSession custom dimension 5
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_dimension_*

NameSession custom dimension *
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse
Notesread more about slots

session_custom_variable_key_1

NameSession custom variable key 1
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_key_2

NameSession custom variable key 2
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_key_3

NameSession custom variable key 3
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_key_4

NameSession custom variable key 4
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_key_5

NameSession custom variable key 5
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_key_*

NameSession custom variable key *
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse
Notesread more about slots

session_custom_variable_value_1

NameSession custom variable value 1
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_value_2

NameSession custom variable value 2
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_value_3

NameSession custom variable value 3
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_value_4

NameSession custom variable value 4
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_value_5

NameSession custom variable value 5
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_custom_variable_value_*

NameSession custom variable value *
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse
Notesread more about slots

session_ecommerce_status

NameShopping stage
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Type[int, str]
Database typeuint8
Nullablefalse
Notessession_ecommerce_status.json

session_entry_title

NameSession entry title
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_entry_url

NameSession entry URL
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_exit_title

NameSession exit title
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_exit_url

NameSession exit URL
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_goal_uuids

NameSession goals
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typearray(uuid)
Database typearray of string(16)
Nullablefalse

session_goals

NameSession goals
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typearray
Database typearray of int32
Nullablefalse

session_id

NameSession ID
Scopesevent, product, session
AvailabilityRaw data API
Typeint
Database typeuint64
Nullablefalse

session_second_title

NameSession second title
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_second_url

NameSession second URL
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

session_total_abandoned_carts

NameAbandoned carts in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_cart_additions

NameAdds to cart in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_cart_removals

NameRemoves from cart in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_content_impressions

NameContent impressions in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_content_interactions

NameContent interactions in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_custom_events

NameCustom events in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_downloads

NameDownloads in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_ecommerce_conversions

NameOrders in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_events

NameEvents in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_goal_conversions

NameGoal conversions in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_outlinks

NameOutlinks in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_page_views

NamePage views in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_product_detail_views

NameProduct detail views in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_site_searches

NameSite searches in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_total_time

NameSession time
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint32
Nullablefalse
Notesin seconds

session_unique_content_impressions

NameUnique content impressions in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_unique_content_interactions

NameUnique content interactions in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_unique_custom_events

NameUnique custom events in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_unique_downloads

NameUnique downloads in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_unique_outlinks

NameUnique outlinks in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_unique_page_views

NameUnique page views in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

session_unique_searches

NameUnique site searches in session
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typeint
Database typeuint16
Nullablefalse

source

NameSource
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

source_medium

NameSource / medium
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

time_on_page

NameTime on page
Scopesevent, product
AvailabilityQuery API, Raw data API
Typeint
Database typeuint32
Nullabletrue
Notesin seconds

timestamp

NameDate
Scopesevent, product, session
AvailabilityReal-time, Query API
Typedate
Database typenot applicable
Nullablefalse
Notesserver time in the website’s time zone

timing_dom_interactive

NameTime until DOM is ready
Scopesevent, product
AvailabilityQuery API, Raw data API
Typeint
Database typeuint32
Nullabletrue
Notesin milliseconds

timing_event_end

NameTime to interact
Scopesevent, product
AvailabilityQuery API, Raw data API
Typeint
Database typeuint32
Nullabletrue

user_id

NameUser ID
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

visitor_days_since_first_session

NameDays since first session
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint16
Nullabletrue

visitor_days_since_last_session

NameDays since last session
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint16
Nullabletrue

visitor_days_since_order

NameDays since last order
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint16
Nullabletrue

visitor_id

NameVisitor ID
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typehex
Database typeuint64
Nullablefalse

visitor_returning

NameReturning visitor
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Type[int, str]
Database typeuint8
Nullablefalse
Notesvisitor_returning.json

visitor_session_number

NameSession number
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typeint
Database typeuint16
Nullablefalse

website_name

NameSite or app name
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typenot applicable
Nullablefalse
Noteswebsite 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 nameTransformation IDSource typesResult type
Unique countunique_countint, strint
Minminfloat, int(as source)
Maxmaxfloat, int(as source)
Averageaveragefloat, intfloat
Medianmedianfloat, int(as source)
Sumsumfloat, int(as source)

Transformation: dimension to dimension

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

Transformation nameTransformation IDSource typesResult type
Date to dayto_datedate, datetimedate
Date to start of hourto_start_of_hourdatetimedatetime
Date to start of weekto_start_of_weekdate, datetimedate
Date to start of monthto_start_of_monthdate, datetimedate
Date to start of quarterto_start_of_quarterdate, datetimedate
Date to start of yearto_start_of_yeardate, datetimedate
Date to hour of dayto_hour_of_daydatetimeint
Date to day of weekto_day_of_weekdate, datetimeint
Date to month numberto_month_numberdate, datetimeint
Date to start of minuteto_start_of_minutedatetimedatetime
Date to start of five minutesto_start_of_five_minutesdatetimedatetime
Date to start of ten minutesto_start_of_ten_minutesdatetimedatetime
Lowercaselowerstrstr
Url to pathto_pathstrstr
Url to domainto_domainstrstr
Url strip query stringstrip_qsstrstr