Flask-Matomo-D 0.0.3

Track requests to your Flask website with Matomo

Flask-Matomo-D

Flask-Matomo-D is a library which lets you track the requests of your Flask website using Matomo (Piwik).

Installation

pip install flask-matomo-d

Usage

from flask import Flask, render_template
from flask_matomo import *

app = Flask(__name__)
matomo = Matomo(app,
                matomo_url="https://matomo.mydomain.com",
                id_site=5,
                token_auth="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                secure=True,
                allowed_paths=None,
                custom_action_name_by_path=None)

@app.route("/")
def index():
  return render_template("index.html")

if __name__ == "__main__":
  app.run()

In the code above:

1. The Matomo object is created by passing in the Flask application and arguments to configure Matomo.
2. The matomo_url parameter is the url to your Matomo installation.
3. The id_site parameter is the id of your site. This is used if you track several websites with on Matomo installation. It can be found if you open your Matomo dashboard, change to site you want to track and look for &idSite= in the url.
4. The token_auth parameter can be found in the area API in the settings of Matomo. It is required for tracking the ip address.
5. The secure parameter indicates whether the verification of trusted certificates is performed, by default is True.
6. The allowed_paths indicates allowed paths of every incoming request to be tracked, use regex sintax. Ex: 'dasd|paht1|admin'
7. The custom_action_name_by_path parameter set custom action_name identifying a part of the String that contains the Request.path. Ex: url: http://www.example.com/myapplication/generic/page.html?x=y Request.path: /generic/page.html

custom_action_name_by_path = {'generic': 'Generic Action in Etc'}

Every requests that contain "generic" in their url path will have their default action_name modified, which is the name of the method invoked in Flask, by the value of the key that was identified. For more info read tracking-api

Docs

Matomo tracking-api Flask api

Meta

Lucas Hild - https://lucas-hild.de This project is licensed under the MIT License - see the LICENSE file for details