Piwik PRO

Source code Package Browser ES5

Piwik PRO is a European, privacy-focused web analytics and marketing platform that helps businesses track website traffic and user behavior.

Installation

TypeScript

Install the destination via npm

npm i @elbwalker/destination-web-piwikpro

import { elb } from '@elbwalker/walker.js';
import destinationPiwikPro from '@elbwalker/destination-web-piwikpro';

elb('walker destination', destinationPiwikPro, config);

Script

Load the destination via dynamic import

<script>
  // Upload the dist/index.mjs on your own server
  const destination = (
    await import(
      'https://cdn.jsdelivr.net/npm/@elbwalker/destination-web-piwikpro/dist/index.mjs'
    )
  ).default;

  elb('walker destination', destination, config);
</script>

Code

Copy the code from the index.browser.js file

(function () {
  'use strict';
  var Destination = (() => {})(); // This is the copied code

  elb('walker destination', Destination.default, config);
})();

Configuration

Configure your PiwikPro destination with your App ID and URL.

Custom Config

{
  appId: 'XXX-XXX-XXX-XXX-XXX', // Id of the site
  // linkTracking: false, // Disable download and outlink tracking
  url: 'https://your_account_name.piwik.pro/', // Same address as the login
}

{ appId: 'XXX-XXX-XXX-XXX-XXX', // Id of the site // linkTracking: false, // Disable download and outlink tracking url: 'https://your_account_name.piwik.pro/', // Same address as the login }

Result

No event yet.

No event yet.

Custom

Property	Type	Description
appId*	string	ID of the Piwik PRO site
url*	string	URL of your Piwik PRO account
linkTracking	boolean	Enables/Disables download and outlink tracking
pageview	boolean	Enables/Disables default pageview events

Properties with a * are required.

CustomEvent

For custom event mapping (mapping.entity.action.custom):

Property	Type	Description
goalId	string	ID to count the event as a goal
goalValue	string	Property to be used as the goal value
name	string	Custom name for the event
value	string	Property to be used for the event value

info

If you need professional support with your walkerOS implementation, check out our services.

Mapping

You are able to map your walkerOS events to match the respective requirements of each vendor. The mapping examples are using a live configuration.

tip

The code examples are interactive. You can edit the code to generate your individual event mapping.

ProductDetailView

Map your walkerOS event to get an ecommerceProductDetailView event.

Event

{
  event: "product view",
  data: {
    id: "ers",
    name: "Everyday Ruck Snack",
    color: "black",
    size: "l",
    price: 420
  },
  context: {
    shopping: [
      "detail",
      0
    ]
  },
  globals: {
    pagegroup: "shop"
  },
  custom: {
    completely: "random"
  },
  user: {
    id: "us3r",
    device: "c00k13",
    session: "s3ss10n"
  },
  nested: [],
  consent: {
    functional: true
  },
  id: "1745367217000-gr0up-1",
  trigger: "load",
  entity: "product",
  action: "view",
  timestamp: 1745367217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.0.7",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ event: "product view", data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 }, context: { shopping: [ "detail", 0 ] }, globals: { pagegroup: "shop" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [], consent: { functional: true }, id: "1745367217000-gr0up-1", trigger: "load", entity: "product", action: "view", timestamp: 1745367217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.0.7", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Custom Config

{
  name: "ecommerceProductDetailView",
  data: {
    set: [
      {
        set: [
          {
            map: {
              sku: "data.id",
              name: "data.name",
              price: "data.price",
              quantity: {
                value: 1
              },
              variant: {
                key: "data.color"
              },
              customDimensions: {
                map: {
                  1: "data.size"
                }
              }
            }
          }
        ]
      },
      {
        map: {
          currencyCode: {
            value: "EUR"
          }
        }
      }
    ]
  }
}

{ name: "ecommerceProductDetailView", data: { set: [ { set: [ { map: { sku: "data.id", name: "data.name", price: "data.price", quantity: { value: 1 }, variant: { key: "data.color" }, customDimensions: { map: { 1: "data.size" } } } } ] }, { map: { currencyCode: { value: "EUR" } } } ] } }

Result

No event yet.

No event yet.

AddToCart

Map your walkerOS event to get an ecommerceAddToCart event.

Event

{
  event: "product add",
  data: {
    id: "ers",
    name: "Everyday Ruck Snack",
    color: "black",
    size: "l",
    price: 420
  },
  context: {
    shopping: [
      "intent",
      0
    ]
  },
  globals: {
    pagegroup: "shop"
  },
  custom: {
    completely: "random"
  },
  user: {
    id: "us3r",
    device: "c00k13",
    session: "s3ss10n"
  },
  nested: [],
  consent: {
    functional: true
  },
  id: "1745367217000-gr0up-1",
  trigger: "click",
  entity: "product",
  action: "add",
  timestamp: 1745367217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.0.7",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ event: "product add", data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 }, context: { shopping: [ "intent", 0 ] }, globals: { pagegroup: "shop" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [], consent: { functional: true }, id: "1745367217000-gr0up-1", trigger: "click", entity: "product", action: "add", timestamp: 1745367217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.0.7", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Custom Config

{
  name: "ecommerceAddToCart",
  data: {
    set: [
      {
        set: [
          {
            map: {
              sku: "data.id",
              name: "data.name",
              price: "data.price",
              quantity: {
                value: 1
              },
              variant: {
                key: "data.color"
              },
              customDimensions: {
                map: {
                  1: "data.size"
                }
              }
            }
          }
        ]
      },
      {
        map: {
          currencyCode: {
            value: "EUR"
          }
        }
      }
    ]
  }
}

{ name: "ecommerceAddToCart", data: { set: [ { set: [ { map: { sku: "data.id", name: "data.name", price: "data.price", quantity: { value: 1 }, variant: { key: "data.color" }, customDimensions: { map: { 1: "data.size" } } } } ] }, { map: { currencyCode: { value: "EUR" } } } ] } }

Result

No event yet.

No event yet.

CartUpdate

Map your walkerOS event to get an ecommerceCartUpdate event.

Event

{
  event: "cart view",
  data: {
    currency: "EUR",
    value: 840
  },
  context: {
    shopping: [
      "cart",
      0
    ]
  },
  globals: {
    pagegroup: "shop"
  },
  custom: {
    completely: "random"
  },
  user: {
    id: "us3r",
    device: "c00k13",
    session: "s3ss10n"
  },
  nested: [
    {
      type: "product",
      data: {
        id: "ers",
        name: "Everyday Ruck Snack",
        color: "black",
        size: "l",
        price: 420,
        quantity: 2
      },
      context: {
        shopping: [
          "cart",
          0
        ]
      },
      nested: []
    }
  ],
  consent: {
    functional: true
  },
  id: "1745367217000-gr0up-1",
  trigger: "load",
  entity: "cart",
  action: "view",
  timestamp: 1745367217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.0.7",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ event: "cart view", data: { currency: "EUR", value: 840 }, context: { shopping: [ "cart", 0 ] }, globals: { pagegroup: "shop" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [ { type: "product", data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420, quantity: 2 }, context: { shopping: [ "cart", 0 ] }, nested: [] } ], consent: { functional: true }, id: "1745367217000-gr0up-1", trigger: "load", entity: "cart", action: "view", timestamp: 1745367217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.0.7", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Custom Config

{
  name: "ecommerceCartUpdate",
  data: {
    set: [
      {
        loop: [
          "nested",
          {
            map: {
              sku: "data.id",
              name: "data.name",
              price: "data.price",
              quantity: {
                value: 1
              },
              variant: {
                key: "data.color"
              },
              customDimensions: {
                map: {
                  1: "data.size"
                }
              }
            }
          }
        ]
      },
      "data.value",
      {
        map: {
          currencyCode: {
            value: "EUR"
          }
        }
      }
    ]
  }
}

{ name: "ecommerceCartUpdate", data: { set: [ { loop: [ "nested", { map: { sku: "data.id", name: "data.name", price: "data.price", quantity: { value: 1 }, variant: { key: "data.color" }, customDimensions: { map: { 1: "data.size" } } } } ] }, "data.value", { map: { currencyCode: { value: "EUR" } } } ] } }

Result

No event yet.

No event yet.

Order

Map your walkerOS event to get an ecommerceOrder event.

Event

{
  event: "order complete",
  data: {
    id: "0rd3r1d",
    currency: "EUR",
    shipping: 5.22,
    taxes: 73.76,
    total: 555
  },
  context: {
    shopping: [
      "complete",
      0
    ]
  },
  globals: {
    pagegroup: "shop"
  },
  custom: {
    completely: "random"
  },
  user: {
    id: "us3r",
    device: "c00k13",
    session: "s3ss10n"
  },
  nested: [
    {
      type: "product",
      data: {
        id: "ers",
        name: "Everyday Ruck Snack",
        color: "black",
        size: "l",
        price: 420
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    },
    {
      type: "product",
      data: {
        id: "cc",
        name: "Cool Cap",
        size: "one size",
        price: 42
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    },
    {
      type: "gift",
      data: {
        name: "Surprise"
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    }
  ],
  consent: {
    functional: true
  },
  id: "1745367217000-gr0up-1",
  trigger: "load",
  entity: "order",
  action: "complete",
  timestamp: 1745367217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.0.7",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ event: "order complete", data: { id: "0rd3r1d", currency: "EUR", shipping: 5.22, taxes: 73.76, total: 555 }, context: { shopping: [ "complete", 0 ] }, globals: { pagegroup: "shop" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [ { type: "product", data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 }, context: { shopping: [ "complete", 0 ] }, nested: [] }, { type: "product", data: { id: "cc", name: "Cool Cap", size: "one size", price: 42 }, context: { shopping: [ "complete", 0 ] }, nested: [] }, { type: "gift", data: { name: "Surprise" }, context: { shopping: [ "complete", 0 ] }, nested: [] } ], consent: { functional: true }, id: "1745367217000-gr0up-1", trigger: "load", entity: "order", action: "complete", timestamp: 1745367217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.0.7", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Custom Config

{
  name: "ecommerceOrder",
  data: {
    set: [
      {
        loop: [
          "nested",
          {
            map: {
              sku: "data.id",
              name: "data.name",
              price: "data.price",
              quantity: {
                value: 1
              },
              variant: {
                key: "data.color"
              },
              customDimensions: {
                map: {
                  1: "data.size"
                }
              }
            }
          }
        ]
      },
      {
        map: {
          orderId: "data.id",
          grandTotal: "data.total",
          tax: "data.taxes",
          shipping: "data.shipping"
        }
      },
      {
        map: {
          currencyCode: {
            value: "EUR"
          }
        }
      }
    ]
  }
}

{ name: "ecommerceOrder", data: { set: [ { loop: [ "nested", { map: { sku: "data.id", name: "data.name", price: "data.price", quantity: { value: 1 }, variant: { key: "data.color" }, customDimensions: { map: { 1: "data.size" } } } } ] }, { map: { orderId: "data.id", grandTotal: "data.total", tax: "data.taxes", shipping: "data.shipping" } }, { map: { currencyCode: { value: "EUR" } } } ] } }

Result

No event yet.

No event yet.