Matomo extension

Once you have installed the analytics integration framework, you must connect to your data supplier. This page describes how to connect to a Matomo data supplier.

You must have an appropriate account and credentials to connect to Matomo.

Connecting Matomo as your data supplier

Define the data supplier(s) for the charts to be displayed in the Analytics app dashboard. Marketers or editors can select the data suppliers you configure when they create dashboards and widgets in the Analytics app.

Data suppliers are defined under: /<module name>/dataSuppliers/<dataSupplierRegistryFile.yaml>.

/matomo/dataSuppliers/demoMatomoSupplier.yaml
class: info.magnolia.analytics.matomo.datasource.MatomoDataSupplierWithTransformer
credentials:
  parameters:
    serverUrl: https://demo.matomo.org
    tokenAuth: anonymous
parameters:
  method: API.get
  module: API
  idSite: 1
  date: last7
  period: day
  format: json
defaultAPIMethodForTotalReport: API.get
Table 1. Properties
Property Description

     class

required

info.magnolia.analytics.matomo.datasource.MatomoDataSupplierWithTransformer

     credentials

required

         parameters

required

             serverUrl

required

The URL to your Matomo server.

             tokenAuth

     parameters

required

The parameters used in the REST call to configure the JSON results retrieved. These parameters vary depending on the data supplier used.

Each parameter is a key-value pair.

For Matomo, at least the format: json key-value is required to retrieve JSON format data.

See the Matomo API documentation to find valid parameters for Matomo. For example, the Matomo example above retrieves JSON format data using the Matomo API.get.

     filteringSubSetExpression

optional

Use to configure segment filtering.

         segment

optional

Expression to filter a segment.

For example: pageUrl=@%s

     defaultAPIMethodForTotalReport

required

Use to configure the API to get a total report. Specific to the Metric number chart.

API suggestion: API.get

Further reading

Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules