Django Google Analytics

Django Google Analytics brings the power of server side/non-js Google Analytics to your Django projects

Contents

• Installation
• Usage
  • 1. HTML tag
  • 2. Middleware + Celery

Installation

1. Install django-google-analytics-app from PyPI or add to your Python path some other way.

2. Add google_analytics to your INSTALLED_APPS setting.

3. Add URL include to your project's urls.py file:

   re_path('djga/', include('google_analytics.urls')),
   

4. Specify a Google Analytics tracking code, i.e.:

   GOOGLE_ANALYTICS = {
       'google_analytics_id': 'UA-000000-2',
   }
   

   where UA-000000-2 is your unique tracking code.

5. If you intend tracking through middleware and Celery remember to install Celery and run its worker process.

Usage

There are two ways to add tracking to your pages.

1. HTML tag

Using <img/> and sticking it in your base.html:

{% load google_analytics_tags %}
<div style="display:none">
    <img src="{% google_analytics %}" width="0" height="0" />
</div>

2. Middleware + Celery

Using Django's middleware, you can process every request and use Celery to make the request to Google Analytics:

MIDDLEWARE = [
    'google_analytics.middleware.GoogleAnalyticsMiddleware',
]

You have to add google_analytics to your CELERY_IMPORTS:

CELERY_IMPORTS = ('google_analytics.tasks')

You can also specify paths that will be excluded when tracking:

GOOGLE_ANALYTICS_IGNORE_PATH = ['/health/', ]