Changes to support % of bounces from /
[ckanext-ga-report.git] / README.rst
David Read 1 ckanext-ga-report
2 =================
3
4 **Status:** Development
5
6 **CKAN Version:** 1.7.1+
7
8
9 Overview
10 --------
11
12 For creating detailed reports of CKAN analytics, including totals per group.
13
14 Whereas ckanext-googleanalytics focusses on providing page view stats a recent period and for all time (aimed at end users), ckanext-ga-report is more interested in building regular periodic reports (more for site managers to monitor).
15
16 Contents of this extension:
17
18 * Use the CLI tool to download Google Analytics data for each time period into this extension's database tables
19
20 * Users can view the data as web page reports
21
22
23 Installation
24 ------------
25
26 1. Activate you CKAN python environment and install this extension's software::
27
28 $ pyenv/bin/activate
Ross Jones 29 $ pip install -e git+https://github.com/datagovuk/ckanext-ga-report.git#egg=ckanext-ga-report
David Read 30
31 2. Ensure you development.ini (or similar) contains the info about your Google Analytics account and configuration::
32
33 googleanalytics.id = UA-1010101-1
Ross Jones 34 googleanalytics.account = Account name (e.g. data.gov.uk, see top level item at https://www.google.com/analytics)
David Read 35 ga-report.period = monthly
Ross Jones 36 ga-report.bounce_url = /
37
38 The ga-report.bounce_url specifies a particular path to record the bounce rate for. Typically it is / (the home page).
39
David Read 40 3. Set up this extension's database tables using a paster command. (Ensure your CKAN pyenv is still activated, run the command from ``src/ckanext-ga-report``, alter the ``--config`` option to point to your site config file)::
Ross Jones 41
David Read 42 $ paster initdb --config=../ckan/development.ini
43
44 4. Enable the extension in your CKAN config file by adding it to ``ckan.plugins``::
45
46 ckan.plugins = ga-report
47
48 Problem shooting
49 ----------------
50
51 * ``(ProgrammingError) relation "ga_url" does not exist``
Ross Jones 52 This means that the ``paster initdb`` step has not been run successfully. Refer to the installation instructions for this extension.
53
54
55 Authorization
56 --------------
57
58 Before you can access the data, you need to set up the OAUTH details which you can do by following the `instructions <https://developers.google.com/analytics/resources/tutorials/hello-analytics-api>`_ the outcome of which will be a file called credentials.json which should look like credentials.json.template with the relevant fields completed. These steps are below for convenience:
59
60 1. Visit the `Google APIs Console <https://code.google.com/apis/console>`_
61
62 2. Sign-in and create a project or use an existing project.
63
64 3. In the `Services pane <https://code.google.com/apis/console#:services>`_ , activate Analytics API for your project. If prompted, read and accept the terms of service.
65
66 4. Go to the `API Access pane <https://code.google.com/apis/console/#:access>`_
67
68 5. Click Create an OAuth 2.0 client ID....
69
70 6. Fill out the Branding Information fields and click Next.
71
72 7. In Client ID Settings, set Application type to Installed application.
73
74 8. Click Create client ID
75
76 9. The details you need below are Client ID, Client secret, and Redirect URIs
77
Ross Jones 78
Ross Jones 79 Once you have set up your credentials.json file you can generate an oauth token file by using the
80 following command, which will store your oauth token in a file called token.dat once you have finished
81 giving permission in the browser::
82
David Read 83 $ paster getauthtoken --config=../ckan/development.ini
84
85
Ross Jones 86 Tutorial
David Read 87 --------
Ross Jones 88
David Read 89 Download some GA data and store it in CKAN's database. (Ensure your CKAN pyenv is still activated, run the command from ``src/ckanext-ga-report``, alter the ``--config`` option to point to your site config file) and specifying the name of your auth file (token.dat by default) from the previous step::
Ross Jones 90
91 $ paster loadanalytics token.dat latest --config=../ckan/development.ini
92
93 The value after the token file is how much data you want to retrieve, this can be
94
95 * **all** - data for all time (since 2010)
96
97 * **latest** - (default) just the 'latest' data
98
David Read 99 * **YYYY-MM-DD** - just data for all time periods going back to (and including) this date
100
101
102
103 Software Licence
104 ================
105
106 This software is developed by Cabinet Office. It is Crown Copyright and opened up under the Open Government Licence (OGL) (which is compatible with Creative Commons Attibution License).
107
108 OGL terms: http://www.nationalarchives.gov.uk/doc/open-government-licence/
109