Metadata-Version: 2.1
Name: odoo-addon-website_analytics_matomo
Version: 18.0.1.0.0.2
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Summary: Track website users using matomo
Home-page: https://github.com/OCA/website
License: AGPL-3
Author: Onestein,Therp BV,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

================
Matomo analytics
================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:edd74b0ef22ba7723ebe01b3123c8624be170fecb4e8f0639e59b28c6b85ebae
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github
    :target: https://github.com/OCA/website/tree/18.0/website_analytics_matomo
    :alt: OCA/website
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/website-18-0/website-18-0-website_analytics_matomo
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/website&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module allows to simply configure your odoo website for using
`Matomo <http://matomo.org>`__.

If your website is a webshop, also consider to install the OCA module
website_sale_analytics_matomo to enable full Ecommerce reporting with
Matomo Analytics.

**Table of contents**

.. contents::
   :local:

Configuration
=============

To configure this module, you need to:

- go to Settings/General Settings/Website
- enable Matomo Analytics
- fill in Matomo website ID and Matomo host

At this point your website is already setup for being tracked in Matomo.

Some more advanced features offered by Matomo can be configured as
follows:

User ID feature
---------------

Matomo includes a User ID feature for enhanced tracking on those
websites that offer the ability for visitors to log in. By tracking the
User ID (unique identifier), it is possible to connect visitors between
visits across multiple dates and devices.

To enable this feature, set \`Enable User ID\`: Matomo will track the
user's ID (model res.users). If you want to use a different field, eg:
user's name or login, you need to override method
compute_matomo_userid().

Enable a Heartbeat timer
------------------------

In order to better measure the time spent in the visit, the active page
can send additional ping requests to Matomo. These requests will not
track additional actions or page views. They just allow Matomo to know
whether the user is actively viewing the page (the tab should be active
and in focus).

To enable this feature, set Enable heartbeat and define the Active Time.

By default, the Active Time is set to 15 seconds, meaning only if the
page was viewed for at least 15 seconds (and the user leaves the page or
focuses away from the tab) then a ping request will be sent.

Matomo Event Tracking
---------------------

As explained in this page
https://matomo.org/faq/reports/implement-event-tracking-with-matomo/ on
the official documentation of Matomo, there are two main ways to set up
event tracking within Matomo:

1. with the "Matomo Tag Manager" feature: this is the easiest and
   recommended way;
2. by adding snippets of JavaScript code to your website itself.

The first method is not supported by this module, however in OCA there's
a dedicated module for that purpose: website_matomo_tag_manager.

The second method can be used along with this module and requires a
little more technical confidence. You will need to integrate a
JavaScript snippet directly into your website’s code.

Technical documentation can be found in:
https://developer.matomo.org/guides/tracking-javascript-guide#manually-trigger-events

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/website/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/website/issues/new?body=module:%20website_analytics_matomo%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Onestein
* Therp BV

Contributors
------------

- Holger Brunn <hbrunn@therp.nl>
- Andrea Stirpe <a.stirpe@onestein.nl>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/website <https://github.com/OCA/website/tree/18.0/website_analytics_matomo>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
