Piwik PRO

Web Source code Package

Piwik PRO is a European, privacy-focused web analytics and marketing platform that helps businesses track website traffic and user behavior. The destination automatically sends events to Piwik Pro via push function. All you need to do is install the destination, and optionally map events to Piwik Pro's format. walkerOS takes care of loading the script and the function calls.

Installation

npm install @walkeros/web-destination-piwikpro

Setup

import { startFlow } from '@walkeros/collector';
import { destinationPiwikPro } from '@walkeros/web-destination-piwikpro';

const { elb } = await startFlow();

elb('walker destination', destinationPiwikPro, {
  settings: {
    appId: 'XXX-XXX-XXX-XXX-XXX', // Required
    url: 'https://your_account_name.piwik.pro/', // Required
  },
});

Configuration reference

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

* Required fields

Settings

{
  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.

Event Mapping

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

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

Mapping examples

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

{
  name: "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: "1760487217000-gr0up-1",
  trigger: "load",
  entity: "product",
  action: "view",
  timestamp: 1760487217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.2.0",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ name: "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: "1760487217000-gr0up-1", trigger: "load", entity: "product", action: "view", timestamp: 1760487217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.2.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Mapping

{
  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

{
  name: "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: "1760487217000-gr0up-1",
  trigger: "click",
  entity: "product",
  action: "add",
  timestamp: 1760487217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.2.0",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ name: "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: "1760487217000-gr0up-1", trigger: "click", entity: "product", action: "add", timestamp: 1760487217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.2.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Mapping

{
  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

{
  name: "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: [
    {
      entity: "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: "1760487217000-gr0up-1",
  trigger: "load",
  entity: "cart",
  action: "view",
  timestamp: 1760487217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.2.0",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ name: "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: [ { entity: "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: "1760487217000-gr0up-1", trigger: "load", entity: "cart", action: "view", timestamp: 1760487217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.2.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Mapping

{
  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

{
  name: "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: [
    {
      entity: "product",
      data: {
        id: "ers",
        name: "Everyday Ruck Snack",
        color: "black",
        size: "l",
        price: 420
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    },
    {
      entity: "product",
      data: {
        id: "cc",
        name: "Cool Cap",
        size: "one size",
        price: 42
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    },
    {
      entity: "gift",
      data: {
        name: "Surprise"
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    }
  ],
  consent: {
    functional: true
  },
  id: "1760487217000-gr0up-1",
  trigger: "load",
  entity: "order",
  action: "complete",
  timestamp: 1760487217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.2.0",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ name: "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: [ { entity: "product", data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 }, context: { shopping: [ "complete", 0 ] }, nested: [] }, { entity: "product", data: { id: "cc", name: "Cool Cap", size: "one size", price: 42 }, context: { shopping: [ "complete", 0 ] }, nested: [] }, { entity: "gift", data: { name: "Surprise" }, context: { shopping: [ "complete", 0 ] }, nested: [] } ], consent: { functional: true }, id: "1760487217000-gr0up-1", trigger: "load", entity: "order", action: "complete", timestamp: 1760487217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.2.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Mapping

{
  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.