| ckanext-ga-report | ckanext-ga-report |
| ================= | ================= |
| **Status:** Development | **Status:** Development |
| **CKAN Version:** 1.7.1+ | **CKAN Version:** 1.7.1+ |
| Overview | Overview |
| -------- | -------- |
| For creating detailed reports of CKAN analytics, including totals per group. | 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). | 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: | Contents of this extension: |
| * Use the CLI tool to download Google Analytics data for each time period into this extension's database tables | * 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 | * Users can view the data as web page reports |
| Installation | Installation |
| ------------ | ------------ |
| 1. Activate you CKAN python environment and install this extension's software:: | 1. Activate you CKAN python environment and install this extension's software:: |
| $ pyenv/bin/activate | $ pyenv/bin/activate |
| $ pip install -e git+https://github.com/okfn/ckanext-ga-report.git#egg=ckanext-ga-report | $ 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:: | 2. Ensure you development.ini (or similar) contains the info about your Google Analytics account and configuration:: |
| googleanalytics.id = UA-1010101-1 | googleanalytics.id = UA-1010101-1 |
| googleanalytics.account = Account name (i.e. data.gov.uk, see top level item at https://www.google.com/analytics) | googleanalytics.account = Account name (i.e. data.gov.uk, see top level item at https://www.google.com/analytics) |
| ga-report.period = monthly | ga-report.period = monthly |
| Note that your credentials will be readable by system administrators on your server. Rather than use sensitive account details, it is suggested you give access to the GA account to a new Google account that you create just for this purpose. | Note that your credentials will be readable by system administrators on your server. Rather than use sensitive account details, it is suggested you give access to the GA account to a new Google account that you create just for this purpose. |
| 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):: | 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 | $ paster initdb --config=../ckan/development.ini |
| 4. Enable the extension in your CKAN config file by adding it to ``ckan.plugins``:: | 4. Enable the extension in your CKAN config file by adding it to ``ckan.plugins``:: |
| ckan.plugins = ga-report | ckan.plugins = ga-report |
| Authorization | Authorization |
| -------------- | -------------- |
| 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: | 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: |
| 1. Visit the `Google APIs Console <https://code.google.com/apis/console>`_ | 1. Visit the `Google APIs Console <https://code.google.com/apis/console>`_ |
| 2. Sign-in and create a project or use an existing project. | 2. Sign-in and create a project or use an existing project. |
| 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. | 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. |
| 4. Go to the `API Access pane <https://code.google.com/apis/console/#:access>`_ | 4. Go to the `API Access pane <https://code.google.com/apis/console/#:access>`_ |
| 5. Click Create an OAuth 2.0 client ID.... | 5. Click Create an OAuth 2.0 client ID.... |
| 6. Fill out the Branding Information fields and click Next. | 6. Fill out the Branding Information fields and click Next. |
| 7. In Client ID Settings, set Application type to Installed application. | 7. In Client ID Settings, set Application type to Installed application. |
| 8. Click Create client ID | 8. Click Create client ID |
| 9. The details you need below are Client ID, Client secret, and Redirect URIs | 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 | 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 | following command, which will store your oauth token in a file called token.dat once you have finished |
| giving permission in the browser:: | giving permission in the browser:: |
| $ paster getauthtoken --config=../ckan/development.ini | $ paster getauthtoken --config=../ckan/development.ini |
| Tutorial | Tutorial |
| -------- | -------- |
| Download some GA data and store it in CKAN's db. (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:: | Download some GA data and store it in CKAN's db. (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 token.dat latest --config=../ckan/development.ini | $ paster loadanalytics token.dat latest --config=../ckan/development.ini |
| The value after the token file is how much data you want to retrieve, this can be | The value after the token file is how much data you want to retrieve, this can be |
| * **all** - data for all time (since 2010) | * **all** - data for all time (since 2010) |
| * **latest** - (default) just the 'latest' data | * **latest** - (default) just the 'latest' data |
| * **YYYY-MM-DD** - just data for all time periods going back to (and including) this date | * **YYYY-MM-DD** - just data for all time periods going back to (and including) this date |
| Software Licence | 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). | 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/ | OGL terms: http://www.nationalarchives.gov.uk/doc/open-government-licence/ |
| import logging | import logging |
| from ckan.lib.base import BaseController, c, render | import operator |
| import report_model | from ckan.lib.base import BaseController, c, render, request, response |
| import sqlalchemy | |
| from sqlalchemy import func, cast, Integer | |
| import ckan.model as model | |
| from ga_model import GA_Url, GA_Stat | |
| log = logging.getLogger('ckanext.ga-report') | log = logging.getLogger('ckanext.ga-report') |
| def _get_month_name(str): | |
| import calendar | |
| from time import strptime | |
| d = strptime('2012-10', '%Y-%m') | |
| return '%s %s' % (calendar.month_name[d.tm_mon], d.tm_year) | |
| def _month_details(cls): | |
| months = [] | |
| vals = model.Session.query(cls.period_name).distinct().all() | |
| for m in vals: | |
| months.append( (m[0], _get_month_name(m))) | |
| return sorted(months, key=operator.itemgetter(0), reverse=True) | |
| class GaReport(BaseController): | class GaReport(BaseController): |
| def csv(self, month): | |
| import csv | |
| entries = model.Session.query(GA_Stat).\ | |
| filter(GA_Stat.period_name==month).\ | |
| order_by('GA_Stat.stat_name, GA_Stat.key').all() | |
| response.headers['Content-disposition'] = 'attachment; filename=dgu_analytics_%s.csv' % (month) | |
| response.headers['Content-Type'] = "text/csv; charset=utf-8" | |
| writer = csv.writer(response) | |
| writer.writerow(["Period", "Statistic", "Key", "Value"]) | |
| for entry in entries: | |
| writer.writerow([entry.period_name.encode('utf-8'), | |
| entry.stat_name.encode('utf-8'), | |
| entry.key.encode('utf-8'), | |
| entry.value.encode('utf-8')]) | |
| def index(self): | def index(self): |
| # Get the month details by fetching distinct values and determining the | |
| # month names from the values. | |
| c.months = _month_details(GA_Stat) | |
| # Work out which month to show, based on query params of the first item | |
| c.month = request.params.get('month', c.months[0][0] if c.months else '') | |
| c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) | |
| entries = model.Session.query(GA_Stat).\ | |
| filter(GA_Stat.stat_name=='Totals').\ | |
| filter(GA_Stat.period_name==c.month).all() | |
| c.global_totals = [(s.key, s.value) for s in entries ] | |
| keys = { | |
| 'Browser versions': 'browsers', | |
| 'Operating Systems versions': 'os', | |
| 'Social sources': 'social_networks', | |
| 'Languages': 'languages', | |
| 'Country': 'country' | |
| } | |
| for k, v in keys.iteritems(): | |
| entries = model.Session.query(GA_Stat).\ | |
| filter(GA_Stat.stat_name==k).\ | |
| filter(GA_Stat.period_name==c.month).\ | |
| order_by('ga_stat.value::int desc').all() | |
| setattr(c, v, [(s.key, s.value) for s in entries ]) | |
| return render('ga_report/site/index.html') | return render('ga_report/site/index.html') |
| class GaPublisherReport(BaseController): | class GaPublisherReport(BaseController): |
| """ | |
| Displays the pageview and visit count for specific publishers based on | |
| the datasets associated with the publisher. | |
| """ | |
| def index(self, id): | def index(self): |
| # Get the month details by fetching distinct values and determining the | |
| # month names from the values. | |
| c.months = _month_details(GA_Url) | |
| # Work out which month to show, based on query params of the first item | |
| c.month = request.params.get('month', c.months[0][0] if c.months else '') | |
| c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) | |
| connection = model.Session.connection() | |
| q = """ | |
| select department_id, sum(pageviews::int) views, sum(visitors::int) visits | |
| from ga_url | |
| where department_id <> '' | |
| and not url like '/publisher/%%' | |
| and period_name=%s | |
| group by department_id order by views desc limit 20; | |
| """ | |
| c.top_publishers = [] | |
| res = connection.execute(q, c.month) | |
| for row in res: | |
| c.top_publishers.append((model.Group.get(row[0]), row[1], row[2])) | |
| return render('ga_report/publisher/index.html') | return render('ga_report/publisher/index.html') |
| def read(self, id): | |
| c.publisher = model.Group.get(id) | |
| c.top_packages = [] # package, dataset_views in c.top_packages | |
| # Get the month details by fetching distinct values and determining the | |
| # month names from the values. | |
| c.months = _month_details(GA_Url) | |
| # Work out which month to show, based on query params of the first item | |
| c.month = request.params.get('month', c.months[0][0] if c.months else '') | |
| c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) | |
| entry = model.Session.query(GA_Url).\ | |
| filter(GA_Url.url=='/publisher/%s' % c.publisher.name).\ | |
| filter(GA_Url.period_name==c.month).first() | |
| c.publisher_page_views = entry.pageviews if entry else 0 | |
| entries = model.Session.query(GA_Url).\ | |
| filter(GA_Url.department_id==c.publisher.name).\ | |
| filter(GA_Url.period_name==c.month).\ | |
| order_by('ga_url.pageviews::int desc')[:20] | |
| for entry in entries: | |
| if entry.url.startswith('/dataset/'): | |
| p = model.Package.get(entry.url[len('/dataset/'):]) | |
| c.top_packages.append((p,entry.pageviews,entry.visitors)) | |
| return render('ga_report/publisher/read.html') | |
| import os | import os |
| import logging | import logging |
| import datetime | import datetime |
| from pylons import config | from pylons import config |
| import ga_model | import ga_model |
| #from ga_client import GA | #from ga_client import GA |
| log = logging.getLogger('ckanext.ga-report') | log = logging.getLogger('ckanext.ga-report') |
| FORMAT_MONTH = '%Y-%m' | FORMAT_MONTH = '%Y-%m' |
| class DownloadAnalytics(object): | class DownloadAnalytics(object): |
| '''Downloads and stores analytics info''' | '''Downloads and stores analytics info''' |
| def __init__(self, service=None, profile_id=None): | def __init__(self, service=None, profile_id=None): |
| self.period = config['ga-report.period'] | self.period = config['ga-report.period'] |
| self.service = service | self.service = service |
| self.profile_id = profile_id | self.profile_id = profile_id |
| def all_(self): | def all_(self): |
| self.since_date(datetime.datetime(2010, 1, 1)) | self.since_date(datetime.datetime(2010, 1, 1)) |
| def latest(self): | def latest(self): |
| if self.period == 'monthly': | if self.period == 'monthly': |
| # from first of this month to today | # from first of this month to today |
| now = datetime.datetime.now() | now = datetime.datetime.now() |
| first_of_this_month = datetime.datetime(now.year, now.month, 1) | first_of_this_month = datetime.datetime(now.year, now.month, 1) |
| periods = ((now.strftime(FORMAT_MONTH), | periods = ((now.strftime(FORMAT_MONTH), |
| now.day, | now.day, |
| first_of_this_month, now),) | first_of_this_month, now),) |
| else: | else: |
| raise NotImplementedError | raise NotImplementedError |
| self.download_and_store(periods) | self.download_and_store(periods) |
| def since_date(self, since_date): | def since_date(self, since_date): |
| assert isinstance(since_date, datetime.datetime) | assert isinstance(since_date, datetime.datetime) |
| periods = [] # (period_name, period_complete_day, start_date, end_date) | periods = [] # (period_name, period_complete_day, start_date, end_date) |
| if self.period == 'monthly': | if self.period == 'monthly': |
| first_of_the_months_until_now = [] | first_of_the_months_until_now = [] |
| year = since_date.year | year = since_date.year |
| month = since_date.month | month = since_date.month |
| now = datetime.datetime.now() | now = datetime.datetime.now() |
| first_of_this_month = datetime.datetime(now.year, now.month, 1) | first_of_this_month = datetime.datetime(now.year, now.month, 1) |
| while True: | while True: |
| first_of_the_month = datetime.datetime(year, month, 1) | first_of_the_month = datetime.datetime(year, month, 1) |
| if first_of_the_month == first_of_this_month: | if first_of_the_month == first_of_this_month: |
| periods.append((now.strftime(FORMAT_MONTH), | periods.append((now.strftime(FORMAT_MONTH), |
| now.day, | now.day, |
| first_of_this_month, now)) | first_of_this_month, now)) |
| break | break |
| elif first_of_the_month < first_of_this_month: | elif first_of_the_month < first_of_this_month: |
| in_the_next_month = first_of_the_month + datetime.timedelta(40) | in_the_next_month = first_of_the_month + datetime.timedelta(40) |
| last_of_the_month = datetime.datetime(in_the_next_month.year, | last_of_the_month = datetime.datetime(in_the_next_month.year, |
| in_the_next_month.month, 1)\ | in_the_next_month.month, 1)\ |
| - datetime.timedelta(1) | - datetime.timedelta(1) |
| periods.append((now.strftime(FORMAT_MONTH), 0, | periods.append((now.strftime(FORMAT_MONTH), 0, |
| first_of_the_month, last_of_the_month)) | first_of_the_month, last_of_the_month)) |
| else: | else: |
| # first_of_the_month has got to the future somehow | # first_of_the_month has got to the future somehow |
| break | break |
| month += 1 | month += 1 |
| if month > 12: | if month > 12: |
| year += 1 | year += 1 |
| month = 1 | month = 1 |
| else: | else: |
| raise NotImplementedError | raise NotImplementedError |
| self.download_and_store(periods) | self.download_and_store(periods) |
| @staticmethod | @staticmethod |
| def get_full_period_name(period_name, period_complete_day): | def get_full_period_name(period_name, period_complete_day): |
| if period_complete_day: | if period_complete_day: |
| return period_name + ' (up to %ith)' % period_complete_day | return period_name + ' (up to %ith)' % period_complete_day |
| else: | else: |
| return period_name | return period_name |
| def download_and_store(self, periods): | def download_and_store(self, periods): |
| for period_name, period_complete_day, start_date, end_date in periods: | for period_name, period_complete_day, start_date, end_date in periods: |
| log.info('Downloading Analytics for period "%s" (%s - %s)', | log.info('Downloading Analytics for period "%s" (%s - %s)', |
| self.get_full_period_name(period_name, period_complete_day), | self.get_full_period_name(period_name, period_complete_day), |
| start_date.strftime('%Y |