Skip to content

Latest commit

 

History

History
113 lines (61 loc) · 4.42 KB

README.rst

File metadata and controls

113 lines (61 loc) · 4.42 KB
Raw

ckanext-ga-report

Status: Development

CKAN Version: 1.7.1+

Overview

For creating detailed reports of CKAN analytics, including totals per group.

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).

Contents of this extension:

  • Use the CLI tool to download Google Analytics data for each time period into this extension's database tables
  • Users can view the data as web page reports

Installation

  1. Activate you CKAN python environment and install this extension's software:

    $ pyenv/bin/activate
$ pip install -e  git+https://github.com/datagovuk/ckanext-ga-report.git#egg=ckanext-ga-report

  2. Ensure you development.ini (or similar) contains the info about your Google Analytics account and configuration:

    googleanalytics.id = UA-1010101-1
googleanalytics.account = Account name (e.g. data.gov.uk, see top level item at https://www.google.com/analytics)
googleanalytics.token.filepath = ~/pyenv/token.dat
ga-report.period = monthly
ga-report.bounce_url = /

    The ga-report.bounce_url specifies a particular path to record the bounce rate for. Typically it is / (the home page).

  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):

    $ paster initdb --config=../ckan/development.ini

  4. Enable the extension in your CKAN config file by adding it to ckan.plugins:

    ckan.plugins = ga-report

Problem shooting

  • (ProgrammingError) relation "ga_url" does not exist This means that the paster initdb step has not been run successfully. Refer to the installation instructions for this extension.

Authorization

Before you can access the data, you need to set up the OAUTH details which you can do by following the instructions 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:

  1. Visit the Google APIs Console
  2. Sign-in and create a project or use an existing project.
  3. In the Services pane , activate Analytics API for your project. If prompted, read and accept the terms of service.
  4. Go to the API Access pane
  5. Click Create an OAuth 2.0 client ID....
  6. Fill out the Branding Information fields and click Next.
  7. In Client ID Settings, set Application type to Installed application.
  8. Click Create client ID
  9. The details you need below are Client ID, Client secret, and Redirect URIs

Once you have set up your credentials.json file you can generate an oauth token file by using the following command, which will store your oauth token in a file called token.dat once you have finished giving permission in the browser:

$ paster getauthtoken --config=../ckan/development.ini

Now ensure you reference the correct path to your token.dat in your CKAN config file (e.g. development.ini):

googleanalytics.token.filepath = ~/pyenv/token.dat

Tutorial

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:

$ paster loadanalytics latest --config=../ckan/development.ini

The value after the token file is how much data you want to retrieve, this can be

  • all - data for all time (since 2010)
  • latest - (default) just the 'latest' data
  • YYYY-MM-DD - just data for all time periods going back to (and including) this date

Software Licence

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).

OGL terms: http://www.nationalarchives.gov.uk/doc/open-government-licence/