.. include:: ../Includes.txt

.. _widgets:

=======
Widgets
=======

You can add the Matomo widgets like any other widget to a dashboard. Please
note, that 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 following widgets are available:

.. contents::
   :depth: 1
   :local:


.. tip::
   Do you miss a widget? Open a `feature request
   <https://github.com/brotkrueml/typo3-matomo-widgets/issues>`_ and perhaps 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. Actions
are:

- Page views
- Downloads
- Clicks on outlinks

.. figure:: ../Images/WidgetActionsPerDay.png
   :alt: Widget Actions per day

   Widget *Actions per day*

Matomo module: VisitsSummary


Actions per month
=================

This widget displays the number of actions per month for the last 12 months.
Actions are:

- Page views
- Downloads
- Clicks on outlinks

.. figure:: ../Images/WidgetActionsPerMonth.png
   :alt: Widget Actions per month

   Widget *Actions per month*

Matomo module: VisitsSummary


Bounce rate
===========

The bounce rate for the current month shows this widget:

.. figure:: ../Images/WidgetBounceRate.png
   :alt: Widget Bounce Rate

   Widget *Bounce rate*

Matomo module: VisitsSummary


Browsers
========

The browser share for the current month shows this widget:

.. figure:: ../Images/WidgetBrowsers.png
   :alt: Widget Browsers

   Widget *Browsers*

Matomo module: DevicesDetection


Campaigns
=========

Displays a report of the campaigns for the current month:

.. figure:: ../Images/WidgetCampaigns.png
   :alt: Widget Campaigns

   Widget *Campaigns*

Matomo module: Referrers


Countries
=========

Shows a list of countries from which the website was visited in the current
month:

.. figure:: ../Images/WidgetCountries.png
   :alt: Widget Countries

   Widget *Countries*

Matomo module: UserCountry


Link to Matomo
==============

A call-to-action widget is used to show a link to the configured Matomo
installation:

.. figure:: ../Images/WidgetLinkToMatomo.png
   :alt: Widget Link to Matomo

   Widget *Link to Matomo*


Operating system families
=========================

The operating system families used by the visitors for the current month:

.. figure:: ../Images/WidgetOsFamilies.png
   :alt: Widget Operating system families

   Widget *Operating system families*

Matomo module: DevicesDetection


Visits per day
==============

This widget displays the number of visits per day for the last 28 days:

.. figure:: ../Images/WidgetVisitsPerDay.png
   :alt: Widget Visits per day

   Widget *Visits per day*

Matomo module: VisitsSummary


Visits per month
================

This widget displays the number of visits per month for the last 12 months:

.. figure:: ../Images/WidgetVisitsPerMonth.png
   :alt: Widget Visits per month

   Widget *Visits per month*

Matomo module: VisitsSummary