search

mikbuch / django-matomo

A simple app to add the Matomo JS tracking code to your template.
9 stars 4 forks source link

Describe how to use django-matomo #1

Open Sammeeey opened 2 years ago

Sammeeey commented 2 years ago

In the readme I can read how to install the package. But it doesn't say anything about the use.

How do I access the data after installing the package to my Django page?

This is probably what they tried to discribe in the Configuration paragraph of the readme.

unclear

Also MATOMO_SITE_ID (e.g. 51) and MATOMO_URL (e.g. 'http://matomo.example.com/', please don't forget the trailing slash!) are required.

In the template, put {% load matomo_tags %} to the top and add {% tracking_code %} before the tag.

Does one literally include {% tracking_code %} in the template file? Or must tracking_code be replaced by a tracking code? If yes, where to get this tracking code from?

Will only the pages be tracked where the respective template language tags from above are included?

Do you actually need a matomo account to use this package?

Will matomo automatically be installed, on the respective URL if MATOMO_URL is defined in settings.py?

Finally: Where do I find my matomo insights?

potential solution

Describe, that one needs to create an account on matomo.org and describe the setup similiar to the respective FAQ

mikbuch commented 2 years ago

Hi @Sammeeey , thank you for the interest in the package.

I will add a more detailed description about how to use the module.

How do I access the data after installing the package to my Django page?

This is probably what they tried to discribe in the Configuration paragraph of the readme.

The assumption behind this Matomo analytics django plugin is that you already have a server to aggregate, store, analyze and visualize the data, and the only thing you do is to configure your website, or web application to send the "raw" data to this server (this is actually the case also for Google Analytics).

So the https://github.com/mikbuch/django-matomo#configuration that you mentioned is in fact only the instruction how to configure the data sending side, not the analytics server itself.

What's the MATOMO_SIDE_ID and where to get it from? What's the MATOMO_URL is it always just the respective domain with a matomo-subdomain? Where should the above infos be added?

The MATOMO_SIDE_ID and MATOMO_URL you get from the Matomo server (where the data should go). These variables should be added to the settings.py.

Does one literally include {% tracking_code %} in the template file? Or must tracking_code be replaced by a tracking code? If yes, where to get this tracking code from?

{% tracking_code %} has to be included literally.

Will only the pages be tracked where the respective template language tags from above are included?

The good practice is to put the {% tracking_code %} in your base.html, so that all the templates building on it will also have analytics. You can of course decide which specific pages should send data to the Matomo server.

Do you actually need a matomo account to use this package?

You need a Matomo server, with your account to use this package. I have been using from proprietary server instances, am I am not that familiar with the other options, e.g., the services/servers provided by the Matomo.

Will matomo automatically be installed, on the respective URL if MATOMO_URL is defined in settings.py?

Matomo will be installed in the sense that the code will be included to the web page that will start sending tracking data to the server.

Finally: Where do I find my matomo insights?

As I mentioned above, you need a separate server for that.

Describe, that one needs to create an account on matomo.org and describe the setup similiar to the respective FAQ

I will do it!

Again, thank you for all the insights 👍

mikbuch commented 2 years ago

Work in progress