mirror of
https://github.com/jazzband/django-analytical.git
synced 2026-03-16 22:20:25 +00:00
88 lines
3.1 KiB
ReStructuredText
88 lines
3.1 KiB
ReStructuredText
=============================
|
|
Intercom.io -- Real-time tracking
|
|
=============================
|
|
|
|
Intercom.io_ is an easy way to implement real-chat and individual
|
|
support for a website
|
|
|
|
.. _Intercom.io: http://www.intercom.io/
|
|
|
|
|
|
.. intercom-installation:
|
|
|
|
Installation
|
|
============
|
|
|
|
To start using the Intercom.io integration, you must have installed the
|
|
django-analytical package and have added the ``analytical`` application
|
|
to :const:`INSTALLED_APPS` in your project :file:`settings.py` file.
|
|
See :doc:`../install` for details.
|
|
|
|
Next you need to add the Intercom.io template tag to your templates.
|
|
This step is only needed if you are not using the generic
|
|
:ttag:`analytical.*` tags. If you are, skip to
|
|
:ref:`intercom-configuration`.
|
|
|
|
The Intercom.io Javascript code is inserted into templates using a
|
|
template tag. Load the :mod:`intercom` template tag library and
|
|
insert the :ttag:`intercom` 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 bottom of the HTML body::
|
|
|
|
{% load intercom %}
|
|
<html>
|
|
<head></head>
|
|
<body>
|
|
<!-- Your page -->
|
|
{% intercom %}
|
|
</body>
|
|
</html>
|
|
...
|
|
|
|
|
|
.. _intercom-configuration:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
Before you can use the Intercom.io integration, you must first set your
|
|
app id.
|
|
|
|
|
|
.. _intercom-site-id:
|
|
|
|
Setting the app id
|
|
--------------------------
|
|
|
|
Intercom.io gives you a unique app id, and the :ttag:`intercom`
|
|
tag will include it in the rendered Javascript code. You can find your
|
|
app id by clicking the *Tracking Code* link when logged into
|
|
the on the intercom.io website. A page will display containing
|
|
HTML code looking like this::
|
|
|
|
<script id="IntercomSettingsScriptTag">
|
|
window.intercomSettings = { name: "Jill Doe", email: "jill@example.com", created_at: 1234567890, app_id: "XXXXXXXXXXXXXXXXXXXXXXX" };
|
|
</script>
|
|
<script>(function(){var w=window;var ic=w.Intercom;if(typeof ic==="function"){ic('reattach_activator');ic('update',intercomSettings);}else{var d=document;var i=function(){i.c(arguments)};i.q=[];i.c=function(args){i.q.push(args)};w.Intercom=i;function l(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src='https://static.intercomcdn.com/intercom.v1.js';var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s,x);}if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})()</script>
|
|
|
|
The code ``XXXXXXXXXXXXXXXXXXXXXXX`` is your app id. Set
|
|
:const:`INTERCOM_APP_ID` in the project :file:`settings.py`
|
|
file::
|
|
|
|
INTERCOM_APP_ID = 'XXXXXXXXXXXXXXXXXXXXXXX'
|
|
|
|
If you do not set an app id, the Javascript code will not be
|
|
rendered.
|
|
|
|
|
|
.. _intercom-internal-ips:
|
|
|
|
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 :const:`ANALYTICAL_INTERNAL_IPS` setting
|
|
(which is :const:`INTERNAL_IPS` by default,) the tracking code is
|
|
commented out. See :ref:`identifying-visitors` for important information
|
|
about detecting the visitor IP address.
|