Links

Piwik PRO

Piwik PRO "Analytics Suite" is a privacy-focused platform for tracking and analyzing user behavior on websites and other digital products. Their product is an alternative to Google Analytics, geared towards compliance with strict security policies and privacy regulations. Using this destination, you can leverage Piwik PRO Tracking HTTP API to send events. The data sent to this API will be processed and eventually appear in Analytics reports.

Key features

The Piwik PRO destination provides the following key features:
  • Events structure: our Events reference model matches Piwik PRO's event types (See query parameter e_t), meaning that your data is properly bridged to the expected fields in an optimized way.
  • Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
  • Smart mapping: data mapping can be readjusted using your datalayer defined fields.
  • Event mapping: change standard mapping between your partners' events and yours or add new mappings.
  • Support for multi-item data: information included in the item array is dispatched to Piwik PRO.

Destination setup

Configuration

Settings
Description
Instance Name
Required
Your instance name as provided by Piwik PRO (E.g. for https://InstanceName.piwik.pro/ppms.php, include the bold string only).
Application Id
Required Your application identifier (Previously "Website Id") as provided by Piwik PRO.
Goal Identifiers
Map your goal identifiers by setting the ids in Piwik PRO goal identifiers and adding event names in Your event name. Goal Id "0" is reserved for E-commerce cart tracking.
Custom Dimensions
Map your custom dimensions by setting their field names in Piwik PRO dimension name and adding its value in Your value. E.g. if you inputsizein the Piwik PRO dimension name and items.0.product.size in Your value, you'll have a custom dimension in Piwik PRO calledsizewith a value based on the content of the field items.0.product.size [1].
In the column Your value path you should keep the default value Default (root) as this will add a custom dimension at the base request level which better fits most scenarios. In case you select either In "items" {items.X} or In "product" {items.X.product} this destination will look for the input event property starting from the items or product level respectively and add it as a custom product dimension. In this scenario, Piwik PRO dimension name must be a numeric string identifier (E.g. 1, 2, ..., N). More details are available following this LINK (See query parameter named ec_products).
Custom Session Variables
Map your custom session variables by setting their field names in Piwik PRO variable name and adding its value in Your value. E.g. if you inputsizein the Piwik PRO variable name and items.0.product.size in Your value, you'll have a custom session variable in Piwik PRO calledsizewith a value based on the content of the field items.0.product.size [1]. More details are available following this LINK (See query parameter named _cvar).
Custom Event Variables
Map your custom event variables by setting their field names in Piwik PRO variable name and adding its value in Your value. E.g. if you inputsizein the Piwik PRO variable name and items.0.product.size in Your value, you'll have a custom event variable in Piwik PRO calledsizewith a value based on the content of the field items.0.product.size [1]. More details are available following this LINK (See query parameter named cvar).
Event Mapping
Change the standard mapping between Piwik PRO's events and yours or add new mappings.
[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.

Quick reference

Commanders Act Events
Piwik PRO Event Types
add_to_cart
add-to-cart
purchase
order
remove_from_cart
remove-from-cart
update_cart
cart-update
[Any Event]
[Any Event] [1]
[1] See Event Mapping for more details.

Field mappings

Most properties can be remapped using our "Smart Mapping" feature. It's recommended to include the visitor identifier in your requets - See Piwik Pro property _id for more details.
Commanders Act Properties
Piwik Pro Properties
Application Id
idsite [*]
context.page.url
url
link
event_name
action_name
user.id
uid [1]
partners.piwik_pro.visitor_id
_id [2]
partners.piwik_pro.config_id
cid [3]
partners.piwik_pro.anon_tracking
uia [4]
context.page.referrer
urlref
Custom Session Variables
_cvar [5]
Custom Event Variables
cvar [6]
context.device.ip
cip
context.device.screen.widthx context.device.screen.height
res [7]
(context.event_timestamp)
h, m, s [8]
context.device.user_agent
ua
context.device.lang
lang
user.country
country
user.city
city
Custom Dimensions
[Custom Dimension] [9]
search_term
search
Goal Identifiers
idgoal [10]
revenue
revenue
ec_st
e_t
id
ec_id
[[items.X.id,items.X.product.name,[items.X.product.category_1, ..., items.X.product.category_5], items.X.product.price,items.X.quantity,items.X.product.brand,items.X.variant, { [Custom Product Dimension Id Y]: [Custom Product Dimension Value Y], ..., [Custom Product Dimension Id Y+N]: [Custom Product Dimension Value Y+N]}]]
ec_products [11]
tax_amount
ec_tx
shipping_amount
ec_sh
(items.X.discount)
ec_dt [12]
partners.piwik_pro.page_view_id
pv_id [13]
partners.piwik_pro.force_new_visit
new_visit [14]
partners.piwik_pro.visit_counter
_idvc [15]
partners.piwik_pro.prev_visit
_viewts [16]
partners.piwik_pro.first_visit
_idts [17]
partners.piwik_pro.download_url
download [18]
partners.piwik_pro.search_categories
search_cats
partners.piwik_pro.search_count
search_count
partners.piwik_pro.last_order_timestamp
_ects [19]
partners.piwik_pro.custom_event_category
e_c [20]
partners.piwik_pro.custom_event_action
e_a [21]
partners.piwik_pro.custom_event_value
e_v [22]
partners.piwik_pro.content_name
c_n [23]
partners.piwik_pro.content_piece
c_p [24]
partners.piwik_pro.content_target
c_t [25]
partners.piwik_pro.content_interaction
c_i [26]
[*] Mandatory property. [1] Can be used to identify visitor by the application (e.g. login name, email address or internal user ID). More details are available following: Recognizing Visitors. [2] This allows you to use the application identifier of a visitor instead of a default identifier generated by Piwik PRO analytics. More details are available following: Recognizing Visitors. If you don't pass a value, this destination tries to recover it from the cookie named _pk_id.[Application Id].More details are available following this LINK. [3] Semi-unique hash generated for the visitor's browser (based on configuration and installed plugins). This parameter overwrites visitor identifier sent with _id property. [4] Whether the user should be tracked anonymously: 1all IP bytes will be masked (0.0.0.0), GeoIP data below country level will be anonymized, 0available visitor data will be added to the session. [5] See Custom Session Variables for more details. [6] See Custom Event Variables for more details. [7] Screen resolution (E.g. 1920x1080). [8] Hour, minute and second when the request was made. [9] See Custom Dimensions for more details. [10] See Goal Identifiers for more details. [11] [Custom Product Dimension Id Y] must be a numeric identifier starting from 1 and must be incremented for every new custom product dimension being set in Custom Dimensions. [12] Sum of all product discounts. [13] Unique page view identifier generated when the page is loaded. [14] Force start of new visit when value is 1. Allowed values: 0 or 1. [15] Visit counter. [16] Time of previous visit in UNIX timestamp format: number of seconds. [17] Time of first visit. [18] URL of downloaded file. [19] Time of the last ecommerce order in UNIX timestamp format: number of seconds. [20] Custom event category. More details are available following this LINK. [21] Custom event action. More details are available following this LINK. [22] Content event value. More details are available following this LINK. [23] Content name. More details are available following this LINK. [24] Content piece. More details are available following this LINK. [25] Content target. More details are available following this LINK. [26] Content interaction. More details are available following this LINK.
Last modified 3mo ago