Django app for extracting and storing UTM tracking values.
Project description
Django UTM Tracker
Django app for extracting and storing UTM tracking values.
Background
This app has been designed to integrate the standard utm_*
querystring parameters
that are used by online advertisers with your Django project.
It does not replace analytics (e.g. Google Analytics) and Adwords tracking, but does have one crucial difference - it allows you to assign a specific user to a campaign advert.
This may be useful if you are trying to assess the value of multiple channels / campaigns.
How it works
The app works as a pair of middleware classes, that extract utm_
values from any
incoming request querystring, and then store those parameters against the request.user
(if authenticated), or in the request.session (if not).
The following shows this workflow (pseudocode - see test_utm_and_lead_source
for a
real example):
client = Client()
# first request stashes values, but does not create a LeadSource as user is anonymous
client.get("/?utm_medium=medium&utm_source=source...")
assert utm_values_in_session
assert LeadSource.objects.count() == 0
# subsequent request, with authenticated user, extracts values and stores LeadSource
user = User.objects.create(username="fred")
client.force_login(user, backend=settings.FORCED_AUTH_BACKEND)
client.get("/")
assert not utm_values_in_session
assert LeadSource.objects.count() == 1
Why split the middleware in two?
By splitting the middleware into two classes, we enable the use case where we can
track leads without utm_
querystring parameters. For instance, if you have an
internal referral program, using a simple token, you can capture this as a
LeadSource
by adding sentinel values to the request.session
:
def referral(request, token):
# do token handling
...
# medium and source are mandatory for lead source capture
request.session["utm_medium"] = "referral"
request.session["utm_source"] = "internal"
# campaign, term and content are optional fields
request.session["utm_campaign"] = "july"
request.session["utm_term"] = token
request.session["utm_content"] = "buy-me"
return render(request, "landing_page.html")
Configuration
Add the app to INSTALLED_APPS
, and add both middleware classes to MIDDLEWARE
.
The UtmSession
middleware must come before LeadSource
middleware.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_utm_tracker-0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65f0285810476022a32815afa719ac4ae9ef9937c3d2445c52ec8c61f5fcba90 |
|
MD5 | b02e442d055bca546fa77340b03d153b |
|
BLAKE2b-256 | e5887eb77bfd9bad6ca769e5ccf5dc601078cc9a7af7c3b5a380052897687c5c |