Piwik Pro

Field reference and API usage

Field ReferencePiwik Pro

Piwik Pro

Web Analytics

Privacy-focused web analytics platform

https://piwik.pro ↗

60 metrics242 dimensions1 data viewapiKey auth

API Usage

Metrics

Traffic & Engagement 17

ID	Name	Symbol
`sessions`	Sessions	number
`visitors`	Visitors	number
`users`	Users	number
`visitor_ips`	Visitor IPs	number
`page_views`	Page Views	number
`unique_page_views`	Unique Page Views	number
`bounce_rate`	Bounce Rate	%
`bounce_rate_events`	Page Bounce Rate	%
`bounces`	Bounces	number
`events`	Events	number
`events_per_session`	Events Per Session	decimal
`entries`	Entries	number
`entry_rate`	Entry Rate	%
`exits`	Exits	number
`exit_rate`	Exit Rate	%
`exit_rate_events`	Exit Rate (Events)	%
`returning_visitors_rate`	% Of Returning Visitors	%

E-commerce 10

ID	Name	Symbol
`ecommerce_conversions`	Orders	number
`ecommerce_conversion_rate`	Order Rate	%
`ecommerce_abandoned_carts`	Abandoned Carts	number
`abandoned_cart_rate`	Cart Abandonment Rate	%
`cart_additions`	Adds To Cart	number
`cart_removals`	Removes From Cart	number
`cart_to_detail_rate`	Cart-To-Detail Rate	%
`order_to_detail_rate`	Order-To-Detail Rate	%
`product_detail_views`	Product Detail Views	number
`product_quantity`	Product Quantity	number

Goals & Conversions 3

ID	Name	Symbol
`goal_conversions`	Goal Conversions	number
`goal_conversion_rate`	Goal Conversion Rate	%
`unique_goal_conversions`	Unique Goal Conversions	number

Content Tracking 5

ID	Name	Symbol
`content_impressions`	Content Impressions	number
`content_interactions`	Content Interactions	number
`content_interaction_rate`	Content Interaction Rate	%
`unique_content_impressions`	Unique Content Impressions	number
`unique_content_interactions`	Unique Content Interactions	number

Custom Events 2

	ID	Name	Symbol
	`custom_events`	Custom Events	number
	`unique_custom_events`	Unique Custom Events	number

Downloads & Outlinks 4

ID	Name	Symbol
`downloads`	Downloads	number
`unique_downloads`	Unique Downloads	number
`outlinks`	Outlinks	number
`unique_outlinks`	Unique Outlinks	number

Site Search 2

	ID	Name	Symbol
	`searches`	Searches	number
	`unique_searches`	Unique Searches	number

Consent Management 15

ID	Name	Symbol
`consent_form_clicks`	Consent Form Clicks	number
`consent_form_impressions`	Consent Form Impressions	number
`consents_analytics`	Consents To Analytics	number
`consents_ab_testing_personalization`	Consents To A/B Testing And Personalization	number
`consents_conversion_tracking`	Consents To Conversion Tracking	number
`consents_marketing_automation`	Consents To Marketing Automation	number
`consents_remarketing`	Consents To Remarketing	number
`consents_user_feedback`	Consents To User Feedback	number
`consents_custom_1`	Custom Consents	number
`consents_any`	Any Consents	number
`consents_first`	First Consents	number
`consents_full`	Full Consents	number
`consents_changed`	Changed Consents	number
`consents_none`	No Consents	number
`consents_no_decision`	No Decisions	number

Bots 2

	ID	Name	Symbol
	`bot_sessions`	Bot Sessions	number
	`bot_rate`	Bot Rate	%

Dimensions

242

Time 3

	ID	Name
	`DATE`	Date
	`MONTH`	Month
	`YEAR`	Year

Traffic Source & Campaigns 10

	ID	Name
	`source`	Source
	`medium`	Medium
	`source_medium`	Source / Medium
	`referrer_type`	Referrer Type
	`referrer_url`	Referrer URL
	`keyword`	Keyword
	`campaign_name`	Campaign Name
	`campaign_id`	Campaign ID
	`campaign_content`	Campaign Content
	`campaign_gclid`	Campaign GCLID

Browser & Technology 15

	ID	Name
	`browser_name`	Browser Name
	`browser_version`	Browser Version
	`browser_engine`	Browser Engine
	`browser_fingerprint`	Browser Fingerprint
	`browser_language_iso639`	Browser Language
	`plugin_cookie`	Plugin Cookie
	`plugin_flash`	Plugin Flash
	`plugin_java`	Plugin Java
	`plugin_pdf`	Plugin PDF
	`plugin_silverlight`	Plugin Silverlight
	`plugin_director`	Plugin Director
	`plugin_gears`	Plugin Gears
	`plugin_quicktime`	Plugin Quicktime
	`plugin_realplayer`	Plugin Realplayer
	`plugin_windowsmedia`	Plugin Windows Media

	ID	Name
	`device_type`	Device Type
	`device_brand`	Device Brand
	`device_model`	Device Model
	`resolution`	Resolution
	`resolution_width`	Resolution Width
	`resolution_height`	Resolution Height

Operating System 2

	ID	Name
	`operating_system`	Operating System
	`operating_system_version`	Operating System Version

Location 13

	ID	Name
	`location_country_name`	Country
	`location_continent_iso_code`	Continent
	`location_city_name`	City
	`location_subdivision_1_name`	Region
	`location_subdivision_2_name`	Subregion
	`location_latitude`	Latitude
	`location_longitude`	Longitude
	`location_metro_code`	Metro Code
	`location_organization`	Organization
	`location_provider`	Provider
	`ipv4_address`	IPv4 Address
	`ipv6_address`	IPv6 Address
	`local_hour`	Local Hour

Pages & Events 16

	ID	Name
	`event_url`	Event URL
	`event_title`	Event Title
	`event_id`	Event ID
	`event_index`	Event Index
	`event_type`	Event Type
	`page_view_index`	Page View Index
	`previous_event_url`	Previous Event URL
	`previous_event_title`	Previous Event Title
	`next_event_url`	Next Event URL
	`next_event_title`	Next Event Title
	`download_url`	Download URL
	`outlink_url`	Outlink URL
	`is_entry`	Is Entry
	`is_exit`	Is Exit
	`is_bounce`	Is Bounce
	`time_on_page`	Time On Page

Custom Events 4

	ID	Name
	`custom_event_action`	Custom Event Action
	`custom_event_category`	Custom Event Category
	`custom_event_name`	Custom Event Name
	`custom_event_value`	Custom Event Value

Custom Dimensions 10

	ID	Name
	`event_custom_dimension_1`	Event Custom Dimension 1
	`event_custom_dimension_2`	Event Custom Dimension 2
	`event_custom_dimension_3`	Event Custom Dimension 3
	`event_custom_dimension_4`	Event Custom Dimension 4
	`event_custom_dimension_5`	Event Custom Dimension 5
	`session_custom_dimension_1`	Session Custom Dimension 1
	`session_custom_dimension_2`	Session Custom Dimension 2
	`session_custom_dimension_3`	Session Custom Dimension 3
	`session_custom_dimension_4`	Session Custom Dimension 4
	`session_custom_dimension_5`	Session Custom Dimension 5

Custom Variables 20

	ID	Name
	`event_custom_variable_key_1`	Event Custom Variable Key 1
	`event_custom_variable_key_2`	Event Custom Variable Key 2
	`event_custom_variable_key_3`	Event Custom Variable Key 3
	`event_custom_variable_key_4`	Event Custom Variable Key 4
	`event_custom_variable_key_5`	Event Custom Variable Key 5
	`event_custom_variable_value_1`	Event Custom Variable Value 1
	`event_custom_variable_value_2`	Event Custom Variable Value 2
	`event_custom_variable_value_3`	Event Custom Variable Value 3
	`event_custom_variable_value_4`	Event Custom Variable Value 4
	`event_custom_variable_value_5`	Event Custom Variable Value 5
	`session_custom_variable_key_1`	Session Custom Variable Key 1
	`session_custom_variable_key_2`	Session Custom Variable Key 2
	`session_custom_variable_key_3`	Session Custom Variable Key 3
	`session_custom_variable_key_4`	Session Custom Variable Key 4
	`session_custom_variable_key_5`	Session Custom Variable Key 5
	`session_custom_variable_value_1`	Session Custom Variable Value 1
	`session_custom_variable_value_2`	Session Custom Variable Value 2
	`session_custom_variable_value_3`	Session Custom Variable Value 3
	`session_custom_variable_value_4`	Session Custom Variable Value 4
	`session_custom_variable_value_5`	Session Custom Variable Value 5

E-commerce Products 23

	ID	Name
	`product_name`	Product Name
	`product_sku`	Product SKU
	`product_brand`	Product Brand
	`product_variant`	Product Variant
	`product_category`	Product Category
	`product_category1`	Product Category 1
	`product_category2`	Product Category 2
	`product_category3`	Product Category 3
	`product_category4`	Product Category 4
	`product_category5`	Product Category 5
	`product_price`	Product Price
	`product_price_app_currency`	Product Price (App Currency)
	`product_price_base_currency`	Product Price (Base Currency)
	`product_quantity`	Product Quantity
	`product_revenue`	Product Revenue
	`product_revenue_app_currency`	Product Revenue (App Currency)
	`product_revenue_base_currency`	Product Revenue (Base Currency)
	`product_dimension1`	Product Dimension 1
	`product_dimension2`	Product Dimension 2
	`product_dimension3`	Product Dimension 3
	`product_dimension4`	Product Dimension 4
	`product_dimension5`	Product Dimension 5
	`product_count`	Product Count

E-commerce Orders & Revenue 20

	ID	Name
	`order_id`	Order ID
	`revenue`	Revenue
	`revenue_app_currency`	Revenue (App Currency)
	`revenue_base_currency`	Revenue (Base Currency)
	`revenue_subtotal`	Revenue Subtotal
	`revenue_subtotal_app_currency`	Revenue Subtotal (App Currency)
	`revenue_subtotal_base_currency`	Revenue Subtotal (Base Currency)
	`revenue_tax`	Revenue Tax
	`revenue_tax_app_currency`	Revenue Tax (App Currency)
	`revenue_tax_base_currency`	Revenue Tax (Base Currency)
	`revenue_shipping`	Revenue Shipping
	`revenue_shipping_app_currency`	Revenue Shipping (App Currency)
	`revenue_shipping_base_currency`	Revenue Shipping (Base Currency)
	`revenue_discount`	Revenue Discount
	`revenue_discount_app_currency`	Revenue Discount (App Currency)
	`revenue_discount_base_currency`	Revenue Discount (Base Currency)
	`lost_revenue`	Lost Revenue
	`lost_revenue_app_currency`	Lost Revenue (App Currency)
	`lost_revenue_base_currency`	Lost Revenue (Base Currency)
	`item_count`	Item Count

Goals 5

	ID	Name
	`goal_id`	Goal ID
	`goal_uuid`	Goal UUID
	`goal_revenue`	Goal Revenue
	`goal_revenue_app_currency`	Goal Revenue (App Currency)
	`goal_revenue_base_currency`	Goal Revenue (Base Currency)

Site Search 3

	ID	Name
	`search_keyword`	Search Keyword
	`search_category`	Search Category
	`search_results_count`	Search Results Count

Content Tracking 3

	ID	Name
	`content_name`	Content Name
	`content_piece`	Content Piece
	`content_target`	Content Target

Consent 11

	ID	Name
	`consent_action`	Consent Action
	`consent_form_button`	Consent Form Button
	`consent_scope`	Consent Scope
	`consent_source`	Consent Source
	`consent_type_analytics`	Consent Type Analytics
	`consent_type_ab_testing_personalization`	Consent Type A/B Testing
	`consent_type_conversion_tracking`	Consent Type Conversion Tracking
	`consent_type_marketing_automation`	Consent Type Marketing Automation
	`consent_type_remarketing`	Consent Type Remarketing
	`consent_type_user_feedback`	Consent Type User Feedback
	`consent_type_custom_1`	Consent Type Custom

Session 32

	ID	Name
	`session_id`	Session ID
	`session_entry_url`	Session Entry URL
	`session_entry_title`	Session Entry Title
	`session_exit_url`	Session Exit URL
	`session_exit_title`	Session Exit Title
	`session_second_url`	Session Second URL
	`session_second_title`	Session Second Title
	`session_ecommerce_status`	Session E-commerce Status
	`session_goals`	Session Goals
	`session_goal_uuids`	Session Goal UUIDs
	`session_total_time`	Session Total Time
	`session_total_page_views`	Session Total Page Views
	`session_total_events`	Session Total Events
	`session_total_custom_events`	Session Total Custom Events
	`session_total_goal_conversions`	Session Total Goal Conversions
	`session_total_ecommerce_conversions`	Session Total E-commerce Conversions
	`session_total_downloads`	Session Total Downloads
	`session_total_outlinks`	Session Total Outlinks
	`session_total_site_searches`	Session Total Site Searches
	`session_total_content_impressions`	Session Total Content Impressions
	`session_total_content_interactions`	Session Total Content Interactions
	`session_total_cart_additions`	Session Total Cart Additions
	`session_total_cart_removals`	Session Total Cart Removals
	`session_total_abandoned_carts`	Session Total Abandoned Carts
	`session_total_product_detail_views`	Session Total Product Detail Views
	`session_unique_page_views`	Session Unique Page Views
	`session_unique_custom_events`	Session Unique Custom Events
	`session_unique_downloads`	Session Unique Downloads
	`session_unique_outlinks`	Session Unique Outlinks
	`session_unique_searches`	Session Unique Searches
	`session_unique_content_impressions`	Session Unique Content Impressions
	`session_unique_content_interactions`	Session Unique Content Interactions

Visitor 9

	ID	Name
	`visitor_id`	Visitor ID
	`visitor_type`	Visitor Type
	`visitor_returning`	Visitor Returning
	`visitor_session_number`	Visitor Session Number
	`visitor_days_since_first_session`	Days Since First Session
	`visitor_days_since_last_session`	Days Since Last Session
	`visitor_days_since_order`	Days Since Order
	`user_id`	User ID
	`cookie_id`	Cookie ID

Performance 8

	ID	Name
	`page_generation_time`	Page Generation Time
	`page_rendering_time`	Page Rendering Time
	`domain_lookup_time`	Domain Lookup Time
	`server_connection_time`	Server Connection Time
	`server_response_time`	Server Response Time
	`redirections_time`	Redirections Time
	`timing_dom_interactive`	DOM Interactive Timing
	`timing_event_end`	Event End Timing

Currency & App Settings 6

	ID	Name
	`app_currency`	App Currency
	`app_currency_conversion_rate`	App Currency Conversion Rate
	`currency_conversion_rates_date`	Currency Conversion Rates Date
	`tracked_currency`	Tracked Currency
	`google_ads_currency`	Google Ads Currency
	`google_ads_app_currency`	Google Ads App Currency

Website 1

	ID	Name
	`website_name`	Website Name

Products (Nested) 22

	ID	Name
	`products.name`	Products Name
	`products.sku`	Products SKU
	`products.brand`	Products Brand
	`products.variant`	Products Variant
	`products.category`	Products Category
	`products.category1`	Products Category 1
	`products.category2`	Products Category 2
	`products.category3`	Products Category 3
	`products.category4`	Products Category 4
	`products.category5`	Products Category 5
	`products.price`	Products Price
	`products.price_app_currency`	Products Price (App Currency)
	`products.price_base_currency`	Products Price (Base Currency)
	`products.quantity`	Products Quantity
	`products.revenue`	Products Revenue
	`products.revenue_app_currency`	Products Revenue (App Currency)
	`products.revenue_base_currency`	Products Revenue (Base Currency)
	`products.dimension1`	Products Dimension 1
	`products.dimension2`	Products Dimension 2
	`products.dimension3`	Products Dimension 3
	`products.dimension4`	Products Dimension 4
	`products.dimension5`	Products Dimension 5

Piwik Pro

Piwik Pro

API Usage

Metrics

Traffic & Engagement 17

E-commerce 10

Goals & Conversions 3

Content Tracking 5

Custom Events 2

Downloads & Outlinks 4

Site Search 2

Consent Management 15

Bots 2

Dimensions

Time 3

Traffic Source & Campaigns 10

Browser & Technology 15

Device 6

Operating System 2

Location 13

Pages & Events 16

Custom Events 4

Custom Dimensions 10

Custom Variables 20

E-commerce Products 23

E-commerce Orders & Revenue 20

Goals 5

Site Search 3

Content Tracking 3

Consent 11

Session 32

Visitor 9

Performance 8

Currency & App Settings 6

Website 1

Products (Nested) 22