Widgets¶
You can add the Matomo widgets like any other widget to a dashboard. Please note, that the widgets have to be enabled in the site configuration and the permissions for editors have to be granted to be able to use these widgets.
Hint
Most widgets need an activated module in Matomo to work. If a module is not available, an error is displayed in the widget. The parameters of the underlying data providers can be adjusted. Have a look into the Widget configuration section.
The following widgets are available. A link to the corresponding page in Matomo is displayed via in icon in the header bar of the widget if the report is available.
Tip
Do you miss a widget? Open a feature request and with a little luck the widget is available in the next release.
Actions per day¶
This widget displays the number of actions per day for the last 28 days (including the current day). Actions are:
Page views
Downloads
Clicks on outlinks
- Matomo module
VisitsSummary
- Active widgets value in
config.yaml
actionsPerDay
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.actionsPerDay.parameters
period: day
date: last28
Actions per month¶
This widget displays the number of actions per month for the last 12 months (including the current month). Actions are:
Page views
Downloads
Clicks on outlinks
- Matomo module
VisitsSummary
- Active widgets value in
config.yaml
actionsPerMonth
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.actionsPerMonth.parameters
period: month
date: last12
Annotations¶
Display a list of the recent annotations in the last 365 days:
- Matomo module
Annotations
- Active widgets value in
config.yaml
annotations
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.annotations.parameters
period: 'month'
date: 'today'
lastN: 365
Create annotation¶
This widget provides a form to create an annotation conveniently from the TYPO3 backend:
After submitting the form, a notification is displayed in the upper right corner of the browser window. If the creation of the annotation was successful, the Note field will be cleared.
- Matomo module
Annotations
- Active widgets value in
config.yaml
createAnnotation
Note
The annotation is stored in Matomo under the user configured in the site configuration. A log entry has been created that can be viewed in the System > Log module. In addition to the user, the date, the note and the note ID received are saved:
Note
For the creation of an annotation the according Matomo user needs only the
view
permission.
Bounce rate¶
Changed in version 3.0: The bounce rate for the last 28 days is displayed. In older versions the rate for the current month has been shown.
The bounce rate for the last 28 days shows this widget:
- Matomo module
VisitsSummary
- Active widgets value in
config.yaml
bounceRate
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.bounceRate.parameters
period: range
date: last28
- matomo_widgets.bounceRate.subtitle
in the last 28 days (incl. today)
Browser plugins¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
This report shows which browser plugins your visitors had enabled in the last 28 days:
- Matomo module
DevicePlugins
- Active widgets value in
config.yaml
browserPlugins
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.browserPlugins.parameters
period: range
date: last28
filter_limit: 50
filter_sort_column: nb_visits
filter_sort_order: desc
Browsers¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
The browser share for the last 28 days shows this widget:
- Matomo module
DevicesDetection
- Active widgets value in
config.yaml
browsers
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.browsers.limit
5
- matomo_widgets.browsers.parameters
period: range
date: last28
filter_sort_column: nb_visits
filter_sort_order: desc
Campaigns¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
Displays a report of the campaigns for the last 28 days:
- Matomo module
Referrers
- Active widgets value in
config.yaml
campaigns
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.campaigns.parameters:
period: range
date: last28
filter_limit: 30
filter_sort_column: nb_visits
filter_sort_order: desc
Content names¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
The content name report is part of content tracking. The widget displays the names, impressions and interaction rate of the content the visitors viewed and interacted with.
- Matomo module
Contents
- Active widgets value in
config.yaml
contentNames
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.campaigns.parameters:
period: range
date: last28
filter_limit: 50
filter_sort_column: nb_impressions
filter_sort_order: desc
Content pieces¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
The content piece report is part of content tracking. The widget displays the pieces, impressions and interaction rate of the content the visitors viewed and interacted with.
- Matomo module
Contents
- Active widgets value in
config.yaml
contentPieces
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.campaigns.parameters:
period: range
date: last28
filter_limit: 50
filter_sort_column: nb_impressions
filter_sort_order: desc
Countries¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
Shows a list of countries from which the website was visited in the last 28 days:
- Matomo module
UserCountry
- Active widgets value in
config.yaml
countries
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.country.parameters:
period: range
date: last28
filter_limit: 50
filter_sort_column: nb_visits
filter_sort_order: desc
Custom dimensions¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
With custom dimensions any custom data can be assigned to visitors or actions. Before a custom dimension can be used as a dashboard widget it has to be configured for a site.
The columns for a custom dimension widget depend on the scope of the custom dimension.
- Matomo module
CustomDimensions
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.customDimension<idDimension>.parameters:
period: range
date: last28
filter_limit: 50
filter_sort_column: nb_visits
filter_sort_order: desc
The <idDimension>
is the ID of the custom dimension as available in the
Matomo configuration.
Scope "action"¶
Scope "visit"¶
JavaScript errors¶
Displays a list of JavaScript errors that occurred in the last 14 days:
Clicking on the message opens a modal with details to this message:
- Matomo module
Events
- Active widgets value in
config.yaml
javaScriptErrors
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.javaScriptErrors.parameters:
period: range
date: last14
filter_limit: 50
filter_sort_column: nb_events
filter_sort_order: desc
Note
To use this widget, JavaScript error tracking must be activated. This can be done either by adding the enableJSErrorTracking code or by enabling the corresponding option in the installed Matomo Integration extension.
Link to Matomo¶
A call-to-action widget is used to show a link to the configured Matomo installation:
- Active widgets value in
config.yaml
linkMatomo
Most viewed pages¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
Show the most viewed pages of a site for the last 28 days:
- Matomo module
Actions
- Active widgets value in
config.yaml
mostViewedPages
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.mostViewedPages.parameters:
period: range
date: last28
filter_sort_column: nb_hits
filter_sort_order: desc
Tip
When you see URLs with the addition "- Others" then Matomo groups pages automatically after a given limit: You can increase the limit. Maybe you want then invalidate the historical reports to adopt the change.
Operating system families¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
The operating system families used by the visitors for the last 28 days:
- Matomo module
DevicesDetection
- Active widgets value in
config.yaml
osFamilies
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.osFamilies.limit:
5
- matomo_widgets.osFamilies.parameters:
period: range
date: last28
filter_sort_column: nb_visits
filter_sort_order: desc
Pages not found¶
List of pages in the last 28 days which returned a status code 404 (not found):
- Matomo module
Actions
- Active widgets value in
config.yaml
pagesNotFound
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.siteSearchKeywords.parameters:
period: range
date: last28
filter_limit: 50
filter_sort_column: nb_hits
filter_sort_order: desc
Site search keywords¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
Overview of the search keywords that visitors searched for on the internal search engine:
- Matomo module
Actions
- Active widgets value in
config.yaml
siteSearchKeywords
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.siteSearchKeywords.parameters:
period: range
date: last28
filter_limit: 50
filter_sort_column: nb_visits
filter_sort_order: desc
Site search keywords with no result¶
Changed in version 3.0: The numbers for the last 28 days are displayed. In older versions the numbers for the current month have been shown.
List of the site search keywords that did not return any search result:
- Matomo module
Actions
- Active widgets value in
config.yaml
siteSearchNoResultKeywords
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.siteSearchNoResultKeywords.parameters:
period: range
date: last28
filter_limit: 50
filter_sort_column: nb_visits
filter_sort_order: desc
Visits per day¶
This widget displays the number of visits per day for the last 28 days:
- Matomo module
VisitsSummary
- Active widgets value in
config.yaml
visitsPerDay
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.visitsPerDay.parameters:
period: day
date: last28
Visits per month¶
This widget displays the number of visits per month for the last 12 months:
- Matomo module
VisitsSummary
- Active widgets value in
config.yaml
visitsPerMonth
- Default configuration parameters in the
Configuration/Services.yaml
file - matomo_widgets.visitsPerMonth.parameters:
period: month
date: last12