Matomo

22min

Summary
Official websites
Site
URL
Website
﻿https://matomo.org/﻿
Documentation
﻿https://matomo.org/help/﻿
Developer integrations
Platform
URL
Android
﻿https://github.com/matomo-org/matomo-sdk-android﻿
iOS
﻿https://github.com/matomo-org/matomo-sdk-ios﻿
Web*﻿
﻿https://developer.matomo.org/guides/tracking-introduction﻿
﻿(*) Available since PXP 3.8
Tracking service
Event support matrix
Overview of the supported events and their configuration.
﻿
Templates
Parameter
﻿Actions﻿
﻿category
action
name
value﻿
﻿not supported﻿
﻿Views﻿
﻿path
title﻿
﻿not supported﻿
﻿Purchases﻿* **﻿
﻿category
action
name
value
product_name
product_category﻿
﻿not supported﻿
﻿Attributes﻿
﻿id﻿
﻿not supported﻿
﻿(*) Purchases contains special handling regarding tracking behavior. More detailed information can be found below in the description of the event configuration for actions and views.
﻿(*﻿*﻿)﻿ ﻿Purchases are supported for native apps only
General structure in tracking_config.json
Tracking service key name in "tracking_config.json" is:
"matomo"
General structure
{
  
  "matomo": {
    "eventsEnabledByDefault": true,
    "viewsEnabledByDefault": true,
    "purchasesEnabledByDefault": true,
    "attributesEnabledByDefault": true,
    
    "events": {
      // your configured list of events
    },
    
    "views": {
      // your configured list of events
    },
    
    "purchases": {
      // your configured list of events
    },
    
    "attributes": {
      // your configured list of attributes
    } 
    
  }
  
}
{
  
  "matomo": {
    "eventsEnabledByDefault": true,
    "viewsEnabledByDefault": true,
    "purchasesEnabledByDefault": true,
    "attributesEnabledByDefault": true,
    
    "events": {
      // your configured list of events
    },
    
    "views": {
      // your configured list of events
    },
    
    "purchases": {
      // your configured list of events
    },
    
    "attributes": {
      // your configured list of attributes
    } 
    
  }
  
}
﻿
Event configuration
Actions
Matomo supports action events. 
Action event
Example
"ISSUE_DOWNLOADED": {
  "templates": {
    "category": "app",
    "action": "issue_downloaded",
    "name": "{{ISSUE_NAME}}",
    "value": "1"
  }
}
"ISSUE_DOWNLOADED": {
  "templates": {
    "category": "app",
    "action": "issue_downloaded",
    "name": "{{ISSUE_NAME}}",
    "value": "1"
  }
}
﻿
Templates
Templatey key
Required
Template value
﻿category﻿
﻿yes﻿
The category of the event.
﻿action﻿
﻿yes﻿
The action of the event.
﻿name﻿
no
The name of the event.
﻿value﻿
no
Must be value that can be parsed as floating point number.
Views
Matomo supports view events.
View event
Example 1
Example 2
"STOREFRONT_FEED": {
  "templates": {
    "path": "/storefront/feed",
    "title": "App/Feed"
  }
}
"STOREFRONT_FEED": {
  "templates": {
    "path": "/storefront/feed",
    "title": "App/Feed"
  }
}
﻿
Templates
Templatey key
Required
Template value
﻿path﻿
﻿yes﻿
Must be a path like in a website.
﻿title﻿
﻿yes﻿
The title of the path.
Purchases
Matomo supports purchase events.
Purchase event
Example
"STOREFRONT_ISSUE_PURCHASED": {
  "templates": {
    "category": "storefront",
    "action": "issue_purchased",
    "name": "{{ISSUE_NAME}}",
    "product_name": "{{PRODUCT_ID}}",
    "product_category": "single_purchase"
  }
}
"STOREFRONT_ISSUE_PURCHASED": {
  "templates": {
    "category": "storefront",
    "action": "issue_purchased",
    "name": "{{ISSUE_NAME}}",
    "product_name": "{{PRODUCT_ID}}",
    "product_category": "single_purchase"
  }
}
﻿
Templates
Matomo offers a specific API to track purchases. Tracking purchase events takes place in two steps:
An event is sent with the value of the price
An additional order item is tracked
(1) Templates used for the event:
Templatey key
Required
Template value
﻿category﻿
﻿yes﻿
The category of the event.
﻿action﻿
﻿yes﻿
The action of the event.
﻿name﻿
no
The name of the event.
(2) Templates used for the order item:
Templatey key
Required
Template value
﻿product_name﻿
no
The name of the product.
﻿product_category﻿
no
The category of the product.
The order item is sent with some additional values:
API
Value
﻿productId﻿
The product id of the purchase.
﻿price﻿
The price of the product.
﻿transactionId﻿
The transaction id of the purchase if available.
﻿quantity﻿
1
Attributes
Matomo supports attributes.
Attribute
Example
"attribute_key": {
  "templates": {
    "id": "value of template"
  }
}
"attribute_key": {
  "templates": {
    "id": "value of template"
  }
}
﻿
Templates
Templatey key
Required
Template value
﻿id﻿
﻿yes﻿
The id of the attribute.
Must be value that can be parsed as integer number.
Additional supported functionality
Custom User ID
Purples generated device id is used for the custom user id (a custom user id is set for native apps only).
How to configure
Native Purple App
Any native Tracking Service is configured in the Purple Manager.﻿
Enable SDK
Settings location
"Your app" => "Consent/Push/Analytics" => "Analytics (General/iOS/Android/Web)"
Setting
Description
Enable Matomo
To enable the Matomo SDK in your app, activate this checkbox.
Matomo URL
The Matomo URL provided by Matomo. 
Matomo Site ID
The Matomo Site id provided by Matomo.
Apple privacy / ATT
Settings location
"Your app" => "Consent/Push/Analytics" => "Privacy"
Consent management
Settings location:
"Your app" => "Consent/Push/Analytics" => "Consent Management"
Setting
Description
Vendor-ID for Matomo
The Vendor-ID is provided by the consent management platform.
Web integration
Enable SDK
Matomo is not explicitly enabled. If a valid configuration of Matomo is present in the "experience.config.json", the SDK is integrated into the HTML document.
Structure in experience.config.json
Plugin configuration
{
  "purple": {
    "analytics": {
    
      "matomo": {
        "configuration": {
          "siteId": "Provided by Matomo",
          "endpointUrl": "Provided by Matomo",
          "scriptSourceUrl": "Provided by Matomo"
        },
        "consent": {
          "vendorId": "Provided by your CMP",
          "iabVendorId": ""
        }
      }
      
    }
  }
}
{
  "purple": {
    "analytics": {
    
      "matomo": {
        "configuration": {
          "siteId": "Provided by Matomo",
          "endpointUrl": "Provided by Matomo",
          "scriptSourceUrl": "Provided by Matomo"
        },
        "consent": {
          "vendorId": "Provided by your CMP",
          "iabVendorId": ""
        }
      }
      
    }
  }
}
﻿
Consent management
If you use one of the CMPs supported by Purple, you must specify the CMP-specific  vendor ID for Matomo, which you can get from your CMP frontend. Additionally, the IAB vendor ID for Matomo can also be added.

Site	URL
Website	https://matomo.org/
Documentation	https://matomo.org/help/

Platform	URL
Android	https://github.com/matomo-org/matomo-sdk-android
iOS	https://github.com/matomo-org/matomo-sdk-ios
Web*	https://developer.matomo.org/guides/tracking-introduction

	Templates	Parameter
Actions	category action name value	not supported
Views	path title	not supported
Purchases* **	category action name value product_name product_category	not supported
Attributes	id	not supported

Templatey key	Required	Template value
category	yes	The category of the event.
action	yes	The action of the event.
name	no	The name of the event.
value	no	Must be value that can be parsed as floating point number.

Templatey key	Required	Template value
path	yes	Must be a path like in a website.
title	yes	The title of the path.

Templatey key	Required	Template value
category	yes	The category of the event.
action	yes	The action of the event.
name	no	The name of the event.

Templatey key	Required	Template value
product_name	no	The name of the product.
product_category	no	The category of the product.

API	Value
productId	The product id of the purchase.
price	The price of the product.
transactionId	The transaction id of the purchase if available.
quantity	1

Templatey key	Required	Template value
id	yes	The id of the attribute. Must be value that can be parsed as integer number.

Setting	Description
Enable Matomo	To enable the Matomo SDK in your app, activate this checkbox.
Matomo URL	The Matomo URL provided by Matomo.
Matomo Site ID	The Matomo Site id provided by Matomo.

Setting	Description
Vendor-ID for Matomo	The Vendor-ID is provided by the consent management platform.

Updated 21 Oct 2024

Did this page help you?

INFOnline (IVW)

Pinpoint