Commanders Act X
Platform XDocumentationWelcome to Success
  • Welcome !
  • Platform updates
    • Announcements
    • Documentation updates
    • Release notes
  • Getting started
    • How the platform works
      • Glossary
        • Condensed platform concepts
    • Platform interface
      • Prod and Testing environments
      • Productivity tools
        • Commander's AI
    • Integrating your data
      • GTM Tutorial
      • OneTag Tutorial
      • Migration guides to the Platform X
        • Migrate from SSv1 to SSv2
          • Send data to serverside v2
            • Purchase event example (ssv1 to ssv2)
        • Migrate from old mobile sdk
  • Features
    • Sources
      • Sources Overview
      • Sources Catalog
        • Web
          • Web container
            • User guides for browser-side platform
              • Container
                • Hosting
                • Creation and modification
                • Generation
                • Testing
                • Deployment and roll back
                • Deletion
                • Statistics
                • Modification history
                • Javascript block
                • Branches
                • Plugin Commanders Act Assistant
              • Tags
                • Add tags
                • Configure tags
                • Rules
                  • Basic actions
                  • Triggers
                  • Perimeters & constraints
              • Data layer and data types
                • External variables
                • Internal variables
                • Event variables
                • Data storage
              • Deduplication
                • Setup guide
                • Setup example
                • Deduplication reports
              • TagPerformance
                • Setup guide
                • Report analysis
                • Troubleshooting
            • Setup guides for developers
              • Web container setup
              • Datalayer setup
              • Browser-side events setup
              • AMP
              • Angular
              • AngularJS
              • React
              • SPA implementation guide
              • VueJS
              • IOT & TV Apps
            • Best Practices
              • FAQ
              • Common Container Strategies
              • Common Trigger Strategies
              • Performance Optimization
              • tC.* attributes and methods
              • APIs
                • Onsite API
              • TMS & Consent banners IDs
          • Javascript SDK
            • Next.js serverside rendering
          • Pixel Tracking API
          • Google Tag Manager (GTM)
          • Shopify
        • Mobile APP
          • Android
          • iOS
          • Flutter
          • React native
        • Advertising
          • Bing Ads (cost import)
          • Facebook Ads (cost import)
          • Criteo (cost import)
          • Realytics
        • Import CRM users
          • API users
          • Users file importer
        • Import conversions
          • API Conversions and Product catalog
          • Conversions files importer
        • Product catalog
          • Product catalog files importer (FTP)
        • Server
          • HTTP tracking API source
            • (deprecated) HTTP tracking API source 1.0
          • Node.JS
          • Python
          • PHP
      • Source Live Event Inspector
      • Source data quality
    • Destinations
      • Destinations overview
        • Automatic Audience replay
      • Destinations catalog
        • AbTasty
        • Actito
        • Adform
        • Adobe
          • Adobe Analytics
          • Adobe Campaign
        • AdRoll
        • Adition
        • Adventori
        • Affilae
        • Alphalyr Marketing Studio
        • Amazon
          • Amazon Ads Conversions API
          • Amazon S3
        • Attraqt
        • Awin
        • Batch Audience
        • Branch Events
        • Button
        • Campaign Analysis Legacy
        • Commission Junction
        • Criteo
          • Criteo - Events
          • Criteo (audiences)
          • Criteo (offline conversions)
        • Data Activation Legacy
        • Dataventure
        • Destination Logs Exporter (closed beta)
        • Dialog-Mail
        • Dynamic Yield
        • Easyence
        • Effinity
        • Eloqua
        • Emarsys
        • Email export
        • Equativ Audience
        • Experian
        • Facebook
          • Facebook Conversions API
            • Facebook CAPI through GTM
            • Performance tab (Event Match Quality)
          • Facebook Custom Audiences
          • Facebook Lead Ads
        • FTP
        • Gamned
        • Google
          • Google Analytics 4
            • Google Analytics 4 - Proxy Mode
          • Google BigQuery
          • Google Conversion Adjustments
          • Google Customer Match
          • Google Display & Video 360
          • Google Enhanced Conversions
          • Google Enhanced Conversions for Leads
          • Google Floodlight Mobile App Conversion
          • Google Search Ads 360 Enhanced Conversions
          • Google Store Sales Direct
        • IBM
        • Inxmail
        • IntelliAd
        • Jellyfish
        • Kameleoon
          • Kameleoon Audience
          • Kameleoon Events
        • Kelkoo
        • Kwanko
        • LinkedIn Conversions API
        • Liveramp
        • Magento
        • Marin Software
        • Mapp
        • Matomo
        • MediaMath
        • Microsoft Advertising Universal Event Tracking
        • Mindlytix
        • Moebel
        • Nextdoor Conversion API
        • OXID
        • Optimizely
        • Outbrain
        • Partnerize
        • Piano Analytics
          • Piano Analytics Collection API
          • Piano Analytics Enrichment API
        • Pinterest
        • Piwik PRO
        • Prediggo
        • Qlik
        • Quantcast
        • Quora Ads Conversion API
        • Rakuten
          • Rakuten Audience
          • Rakuten Events
        • Realytics
        • Reddit Conversions API
        • Responsys
        • RhythmOne
        • Rich Relevance
        • RTB House Audience
        • Salesforce
          • Salesforce Audience Studio
          • Salesforce Marketing Cloud
          • Salesforce Commerce Cloud
        • SAP Commerce Cloud
        • Selligent
        • Skai
        • Smart Adserver
        • SmartFocus
        • Snapchat Conversions API
        • Splio
        • Syte
        • Tableau Online
        • Taboola
          • Taboola Audience
          • Taboola Events
        • Target2sell
        • Temelio
        • Teradata
        • The Trade Desk
          • The Trade Desk Conversions API
          • The Trade Desk Audience
        • TikTok
          • TikTok Events API
          • TikTok Offline Events
        • TimeOne
        • Tradedoubler
        • TradeTracker
        • X (Twitter) Conversion API
        • Xandr
        • Webhook
        • Webtrends
        • ZBO Media
        • Zeta
      • Destination builder
        • Javascript destination builder
          • Tutorial - How to build a server destination with the JS sandbox
          • Serverside javascript helpers
      • Destination filters
      • Mapping and Properties transformation
      • Event delivery
      • Destination event inspector
      • Dry mode (lab)
    • Enrichments
      • Augmented User Attributes
        • Business case
      • Events enrichment
      • Storage Settings
    • Data Quality
      • Event Specification
      • Sources data quality
      • Data cleansing
        • Supported transformation functions - Data cleansing
          • Format a date
    • Identity resolution
      • Migrate from Fuse v1 to Fuse v2
    • Customers
      • Segment
        • Segment overlap
        • Segment stats
    • Explore
      • Campaign analysis
        • Attribution
        • Control Group (Closed Beta )
      • User analysis
        • Dashboards
      • Consent Analysis
    • Consent management
      • Responsability of actors
      • Setup Guides
        • Tag Manager
          • Commanders Act TMS
          • Google Tag Manager (GTM)
          • Google Tag Manager (GTM) - Consent Mode
          • Google Consent Mode in Commanders Act CMP
          • Adobe Launch
        • Websites (Hardcoded)
        • FR : Suppression des cookies lors du retrait du consentement
        • Mobile apps
          • iOS
            • ATT - App Tracking Transparency (iOS 14.5+)
          • Android
      • User Guides
        • Categories & Tags
          • Manage Categories
          • Manage Vendors
          • Assign Categories
        • Privacy Banners
          • Banner Templates
            • Accessibility Template
          • Manage Banner
          • Deploy Banner
          • Copy Banner
        • Consent Analysis
        • Exports
        • Settings
      • Extensions
        • Cookie Scanner
        • Piggybacking
        • Tag Firewall
      • Marketing Preferences Center (additional module)
      • Knowledge Base
        • Consent Object
        • Consent cookies exemption
          • Implementation guide for exempted consent statistics FR market
        • Consent Cookie
        • IAB TCF V2.2 Release details
          • IAB TCF v2.2 CMP requirements
          • IAB TCF v2.2 Migration guide Web
          • IAB TCF v2.2 Migration guide App
        • IAB TCF V2.2 Consent
        • IAB TCF V2.2 and Google FAQ
        • Google ACM requires IAB TCF
        • CCPA & Global Privacy control
      • Rest Data API
        • GET/PUT Consents / preferences
      • OnSite API
        • Getting Started
        • consent.get
        • consent.update
        • consent.revoke
        • consent.onUpdate
        • consent.onReady
        • consentBanner.show
        • consentBanner.hide
        • consentCenter.show
        • consentCenter.hide
      • Platform API
        • Get statistics
  • Use cases
    • Data activation
      • Engage new customers
        • Welcome banner for new customers
        • Real-time promotion for hesitant customers
        • Discount banner for installing the application
        • Personalized ads
        • Engage similar audience (lookalike)
      • Increase loyalty
        • Drive to favourite store
        • Increase Customer Lifetime Value with a loyalty program
        • Notification about order delay
      • Increase revenue
        • Abandoned cart
        • Products recommendations
        • Complementary product offer
      • Retain customers
        • Identify a churn risk with RFM segmentation
        • Identify customers’ preferred channel
        • Contact with the customer support
      • Advocacy
        • Incentive to share customers' experience and rating
        • Sponsorship Program
        • Social Media Hashtag
    • Website performance
    • Consent banners A/B testing
    • Customer analysis
    • Campaigns performance analysis
  • Developers
    • Tracking & Integrations
      • Tracking
        • About events
          • E-commerce/retail events
          • Web event specificity
          • Mobile App event specificity
        • Events reference
          • Common events
          • E-commerce events
          • Video events
          • Campaign Tracking events
        • Properties reference
          • Global properties
          • Video properties
          • Permanent properties
        • Data API
          • HTTP API
          • Segment API
          • User API
          • Product catalog and conversion API
      • Server IP Whitelisting
    • Config API
    • Changelogs
      • Measure.js changelog
      • Web container generator
    • Content Security Policy
  • CONFIGURE
    • Data Management
      • Events collection
      • Data retention duration
      • Data Governance
    • Administration
      • User management
      • Domain Management
        • WAF Proxy (CloudFlare,...)
        • A record
        • CNAME record
        • On-Premise Proxy
        • Cookie CAID
        • First party hosting
      • Single Sign-On
      • Two-factor authentication (2FA)
      • Copy Management
    • Cookies
      • Cookie 1st
      • Cookie sync partners
      • First domain tracking (Phoenix)
    • Disclaimer
Powered by GitBook
On this page
  • Key features
  • Destination setup
  • Configuration
  • Quick reference
  • Field mappings

Was this helpful?

Edit on GitHub
Export as PDF
  1. Features
  2. Destinations
  3. Destinations catalog

Piwik PRO

PreviousPinterestNextPrediggo

Last updated 9 months ago

Was this helpful?

"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 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 model matches (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 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].

Custom Session Variables

Custom Event Variables

Event Mapping

Change the standard mapping between Piwik PRO's events and yours or add new mappings.

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]

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]

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 or 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 (See query parameter named ec_products).

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 (See query parameter named _cvar).

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 (See query parameter named cvar).

[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.

[1] See for more details.

See

[*] 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: . [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: . 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 . [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: 1 all IP bytes will be masked (0.0.0.0), GeoIP data below country level will be anonymized, 0 available visitor data will be added to the session. [5] See for more details. [6] See for more details. [7] Screen resolution (E.g. 1920x1080). [8] Hour, minute and second when the request was made. [9] See for more details. [10] See 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 . [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 . [21] Custom event action. More details are available following this . [22] Content event value. More details are available following this . [23] Content name. More details are available following this . [24] Content piece. More details are available following this . [25] Content target. More details are available following this . [26] Content interaction. More details are available following this .

Piwik PRO
Tracking HTTP API
Events reference
Piwik PRO's event types
item
Events reference
Event Mapping
Recognizing Visitors
Recognizing Visitors
LINK
LINK
LINK
LINK
LINK
LINK
LINK
LINK
Custom Session Variables
Custom Event Variables
Custom Dimensions
Goal Identifiers
Custom Dimensions
items
product
LINK
LINK
LINK
Quick reference