KISSmetrics – funnel analysis¶
KISSmetrics is an easy to implement analytics solution that provides a powerful visual representation of your customer lifecycle. Discover how many visitors go from your landing page to pricing to sign up, and how many drop out at each stage.
Installation¶
To start using the KISSmetrics integration, you must have installed the
django-analytical package and have added the analytical
application
to INSTALLED_APPS
in your project settings.py
file.
See Installation and configuration for details.
Next you need to add the KISSmetrics template tag to your templates.
This step is only needed if you are not using the generic
analytical.*
tags. If you are, skip to
Configuration.
The KISSmetrics Javascript code is inserted into templates using a
template tag. Load the kiss_metrics
template tag library and
insert the kiss_metrics
tag. Because every page that you want
to track must have the tag, it is useful to add it to your base
template. Insert the tag at the top of the HTML head:
{% load kiss_metrics %}
<html>
<head>
{% kiss_metrics %}
...
Configuration¶
Before you can use the KISSmetrics integration, you must first set your API key.
Setting the API key¶
Every website you track events for with KISSmetrics gets its own API
key, and the kiss_metrics
tag will include it in the rendered
Javascript code. You can find the website API key by visiting the
website Product center on your KISSmetrics dashboard. Set
KISS_METRICS_API_KEY
in the project settings.py
file:
KISS_METRICS_API_KEY = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
If you do not set an API key, the tracking code will not be rendered.
Internal IP addresses¶
Usually you do not want to track clicks from your development or
internal IP addresses. By default, if the tags detect that the client
comes from any address in the KISS_METRICS_INTERNAL_IPS
setting, the tracking code is commented out. It takes the value of
ANALYTICAL_INTERNAL_IPS
by default (which in turn is
INTERNAL_IPS
by default). See Identifying authenticated users for
important information about detecting the visitor IP address.
Identifying users¶
If your websites identifies visitors, you can pass this information on to KISSmetrics so that you can tie events to users. By default, the username of an authenticated user is passed to KISSmetrics automatically. See Identifying authenticated users.
You can also send the visitor identity yourself by adding either the
kiss_metrics_identity
or the analytical_identity
variable to the
template context. If both variables are set, the former takes
precedence. For example:
context = RequestContext({'kiss_metrics_identity': identity})
return some_template.render(context)
If you can derive the identity from the HTTP request, you can also use
a context processor that you add to the
TEMPLATE_CONTEXT_PROCESSORS
list in settings.py
:
def identify(request):
try:
return {'kiss_metrics_identity': request.user.email}
except AttributeError:
return {}
Just remember that if you set the same context variable in the
RequestContext
constructor and in a
context processor, the latter clobbers the former.
Alias¶
Alias is used to associate one identity with another. This most likely will occur if a user is not signed in yet, you assign them an anonymous identity and record activity for them and they later sign in and you get a named identity.
For example:
context = RequestContext({
'kiss_metrics_alias': {'my_registered@email' : 'my_user_id'},
})
return some_template.render(context)
The output script tag will then include the corresponding properties as documented in the KISSmetrics alias API docs.
Recording events¶
You may tell KISSmetrics about an event by setting a variable in the context.
For example:
context = RequestContext({
'kiss_metrics_event': ['Signed Up', {'Plan' : 'Pro', 'Amount' : 9.99}],
})
return some_template.render(context)
The output script tag will then include the corresponding Javascript event as documented in the KISSmetrics record API docs.
Recording properties¶
You may also set KISSmetrics properties without a corresponding event.
For example:
context = RequestContext({
'kiss_metrics_properties': {'gender': 'Male'},
})
return some_template.render(context)
The output script tag will then include the corresponding properties as documented in the KISSmetrics set API docs.