<h1 class="title">Matomo analytics</h1> <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/website/tree/15.0/website_analytics_matomo"><img alt="OCA/website" src="https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/website-15-0/website-15-0-website_analytics_matomo"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/186/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This module allows to simply configure your odoo website for using <a class="reference external" href="http://matomo.org">Matomo</a>.</p> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#configuration" id="id1">Configuration</a><ul> <li><a class="reference internal" href="#user-id-feature" id="id2">User ID feature</a></li> <li><a class="reference internal" href="#enable-a-heartbeat-timer" id="id3">Enable a Heartbeat timer</a></li> <li><a class="reference internal" href="#matomo-event-tracking" id="id4">Matomo Event Tracking</a></li> </ul> </li> <li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id6">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id7">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id9">Maintainers</a></li> </ul> </li> </ul> </div> <a name="configuration"></a> <h2><a class="toc-backref" href="#id1">Configuration</a></h2> <p>To configure this module, you need to:</p> <ul class="simple"> <li>go to Settings/General Settings/Website</li> <li>enable <cite>Matomo Analytics</cite></li> <li>fill in <cite>Matomo website ID</cite> and <cite>Matomo host</cite></li> </ul> <p>At this point your website is already setup for being tracked in Matomo.</p> <p>Some more advanced features offered by Matomo can be configured as follows:</p> <a name="user-id-feature"></a> <h3><a class="toc-backref" href="#id2">User ID feature</a></h3> <p>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.</p> <p>To enable this feature, set <cite>Enable User ID</cite>: Matomo will track the user's <cite>ID</cite> (model <cite>res.users</cite>). If you want to use a different field, eg: user's <cite>name</cite> or <cite>login</cite>, you need to override method <cite>compute_matomo_userid()</cite>.</p> <a name="enable-a-heartbeat-timer"></a> <h3><a class="toc-backref" href="#id3">Enable a Heartbeat timer</a></h3> <p>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).</p> <p>To enable this feature, set <cite>Enable heartbeat</cite> and define the Active Time.</p> <p>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.</p> <a name="matomo-event-tracking"></a> <h3><a class="toc-backref" href="#id4">Matomo Event Tracking</a></h3> <p>As explained in this page <a class="reference external" href="https://matomo.org/faq/reports/implement-event-tracking-with-matomo/">https://matomo.org/faq/reports/implement-event-tracking-with-matomo/</a> on the official documentation of Matomo, there are two main ways to set up event tracking within Matomo:</p> <ol class="arabic simple"> <li>with the &quot;Matomo Tag Manager&quot; feature: this is the easiest and recommended way;</li> <li>by adding snippets of JavaScript code to your website itself.</li> </ol> <p>The first method is not supported by this module, however in OCA there's a dedicated module for that purpose: <cite>website_matomo_tag_manager</cite>.</p> <p>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.</p> <p>Technical documentation can be found in: <a class="reference external" href="https://developer.matomo.org/guides/tracking-javascript-guide#manually-trigger-events">https://developer.matomo.org/guides/tracking-javascript-guide#manually-trigger-events</a></p> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id5">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/website/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/OCA/website/issues/new?body=module:%20website_analytics_matomo%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id6">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id7">Authors</a></h3> <ul class="simple"> <li>Onestein</li> <li>Therp BV</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id8">Contributors</a></h3> <ul class="simple"> <li>Holger Brunn &lt;<a class="reference external" href="mailto:hbrunn&#64;therp.nl">hbrunn&#64;therp.nl</a>&gt;</li> <li>Andrea Stirpe &lt;<a class="reference external" href="mailto:a.stirpe&#64;onestein.nl">a.stirpe&#64;onestein.nl</a>&gt;</li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id9">Maintainers</a></h3> <p>This module is maintained by the OCA.</p> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <p>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.</p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/website/tree/15.0/website_analytics_matomo">OCA/website</a> project on GitHub.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>