Matomo Destination

Destination Info

• Accepts Page, and Track calls
• In Device-mode, refer to it as Piwik in the Integrations object

Components

• Browser

Connection Modes

Device-mode	Cloud-mode
Web	Web
Mobile	Mobile
Server	Server

Matomo, formerly Piwik, is the leading open source web analytics platform that gives you valuable insights into your website’s visitors, your marketing campaigns and much more, so you can optimize your strategy and online experience of your visitors.

Segment’s Matomo destination code is open-source and can be viewed on GitHub:

• Javascript

Getting Started

1. From the Segment web app, click Catalog.
2. Search for “Matomo” in the Catalog, select it, and choose which of your sources to connect the destination to. Note the source must be sending events using our JavaScript library Analytics.js.
3. In the destination settings, enter your Site ID. You can find your Site ID in your Matomo snippet.
4. In the destination settings, enter your Server URL. You can find your Server URL in your snippet, we will append /matomo.php to the URL automatically.
5. When you enable Matomo in your Segment settings, Segment’s CDN is updated within 45 minutes. Once that happens, Segment asynchronously loads matomo.js on your page whenever it is loaded. This means you should remove Matomo’s snippet from your page.

Page

If you’re not familiar with the Segment Specs, take a look to understand what the Page method does. An example call would look like:

analytics.page();

Our Page method triggers a call to Matomo’s trackPageView method.

Identify

If you’re not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

analytics.identify('97980cfea0068');

Our Identify method triggers a call to Matomo’s setUserId method and will send the userId to Matomo.

Track

If you’re not familiar with the Segment Specs, take a look to understand what the Track method does. An example call would look like:

analytics.track('Logged In');

We’ll record a Matomo event whenever you make a track call.

For the example above, these event attributes are sent to Matomo:

Find below another Track example, this time with all the available Matomo event parameters:

analytics.track('Created Account', {
  category: 'Account',
  label: 'Premium',
  value: 30
})

That call will create a Matomo Event with these attributes:

For Event Value you can name the event property value or revenue. We’ll look for value first, then fall back to revenue.

Best Pratices

Matomo allows you to set custom variables with your pageviews and events. With Segment, you can set page-scoped custom variables with any track call you make with analytics.js.

Since these custom variables must be mapped to an index you define, which can change from call to call, the only way we can support these custom variables with full flexibility is to allow you to pass your map in the context.Matomo.customVars dictionary of each call.

To take advantage of this feature, your track calls should look like this:

Note The destination’s name is still “piwik” in the JSON for these calls.

analytics.track('event', {
  property: 'property'
}, { integrations: {
  Piwik: {
    customVars: {
      1: ["<variableName>", "<variableValue>"],
      2: ['SubscriptionId', '1234'],
      3: ['PlanName', 'ENTERPRISE']
      }
    }
  }
})

Goals

If you want to flag specific events as Matomo Goals you can do so by mapping those events in your Segment Source Destinations page under Matomo Settings.

Fill in the event on the left and the Goal ID from Matomo on the right. Then every time the event happens we’ll fire Matomo’s trackGoal method.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.