Usage Statistics

From MPublishing

Revision as of 15:03, 1 March 2011 (edit) Kshawkin (Talk | contribs) (added Google Analytics code) ← Older edit		Current revision (14:35, 8 October 2015) (edit) (undo) Jmcglone (Talk | contribs) (→The Michigan system)
(47 intermediate revisions not shown.)
Line 1:		Line 1:
-	There are two interfaces to the statistics system:	+	== Introduction ==
-	* http://quod.lib.umich.edu/cgi/s/stats/subscriber – From this page, you can generate reports for any open-access publication or for any subscription publication your institution subscribes to. (In order to get statistics for restricted collections, you must access the system via an institutional IP address; there is no login or authentication by proxy.)  It shares aggregate usage statistics and statistics about usage from your institution's IP address.	+	We have two systems for tracking usage of a publication:
-	* http://quod.lib.umich.edu/cgi/s/stats/manager – This page is only available to those who are designated as a manager of a publication.  From this page, you can generate reports for any publication for which you are a manager, with statistics broken down by institutional IP address.	+	* Google Analytics: This provides visual and tabular data based on unique URLs. You can filter the data based on substrings of URLs, allowing an easy way to track usage of particular titles or particular system functions.
		+	* Michigan's homegrown system: This system is used for publications hosted in DLXS on quod.lib.umich.edu.  The system is aware of DLXS's URL structure and is able to equate URLs that are functionally equivalent and compile data on different types of searches and different types of browsing
-	To generate a report, first select one or more collections. Selecting more than one collection will generate a report that lists the statistics for each collection in successive tables, not an aggregation. (Select more than one collection by holding down the control key as you click.) Next, choose which kind of report you would like to receive: custom or COUNTER.	+	== Google Analytics ==
-	= Custom Reports =	+	A publishing partner's principal contact at Michigan Publishing can get you access to [http://www.google.com/analytics Google Analytics] for your publication.  Just provide an email address attached to a Google Account which which you'd like access to the data to be shared.
-	The custom report shows total usage statistics for the titles you select, as well as hits broken down by category, such as browse (by author, by title, etc.), search (Boolean, simple, etc.), and view (table of contents, full text, etc.). These categories can be customized by SPO for a particular publication, but by default any page visited will be counted in one of these categories based on what is in the URL.  Note that not all of these options will be applicable to every publication.	+	By default we set up GA to track all web pages hosted on on quod.lib.umich.edu (where Michigan Publishing journals and other digital publications live) and, if applicable, on any pages on a domain name hosted by Michigan Publishing. If a publishing partner maintains a website on their own devoted to the publication, visits to that site are not included in our GA by default but can be added to the tracking by coordinating with your contact at Michigan Publishing.
-	<table>	+	In the summer of 2013, practicum student Clayton Hayes created a series of guides for our publishing partners who wish to use Google Analytics. These include:
-	<tr><th>label</th><th>URL parameter(s)</th></tr>	+
-	<tr><td>author</td><td>(page=browse OR page=browseentries) AND key=author</td></tr>	+
-	<tr><td>other</td><td>(not usually used for SPO publications)</td></tr>	+
-	<tr><td>title</td><td>page=browse OR page=browseentries BUT WITHOUT key=author</td></tr>	+
-	<tr><td>word wheel</td><td>(not usually used for SPO publications)</td></tr>	+
-	<tr><td>bibl</td><td>type=bib</td></tr>	+
-	<tr><td>bool</td><td>type=boolean</td></tr>	+
-	<tr><td>prox</td><td>type=proximity</td></tr>	+
-	<tr><td>simple</td><td>type=simple</td></tr>	+
-	<tr><td>pg/img</td><td>seq= AND idno= BUT WITHOUT ANY OF THE FOLLOWING: view=text, view=header, view=toc, or page=.*nav</td></tr>	+
-	<tr><td>t.o.c.</td><td>view=header</td></tr>	+
-	<tr><td>text</td><td>view=text OR idno= BUT WITHOUT page=.*nav</td></tr>	+
-	</table>	+
-	In a custom report, you can view a summary of statistics by month for the lifetime of the collection or for a specific time range. The dropdown menu allows you to choose to show the report as HTML in your browser or to download an Excel file. If you have selected more than one collection, they will be displayed as a single HTML page or in multiple Excel worksheets.	+	* [[Media:Guide_to_Google_Analytics.pdf | An overview of the Google Analytics dashboard and basic functions]]
		+	* [[Media:What_is_The_Purpose_of_GA.pdf | An overview of how GA data may be useful to journal editors and other publishing partners]]
		+	* [[Media:Adding_Annotations_to_Reports.pdf | A step-by-step guide to adding your own annotations to the GA timeline for your publication]]
		+	* [[Media:Creating_Email_Alerts.pdf | A step-by-step guide to setting up email alerts to receive a message when specific criteria are met]]
		+	* [[Media:Creating_Custom_Events.pdf | A step-by-step guide to creating custom events, that is, specific criteria that GA does not track by default, but that you want to track]]
-	By default, the custom report shows both aggregate statistics (for all institutions) and statistics for just your institution. In the HTML view, you can hide one set of statistics by clicking ‘collapse.’	+	These guides are available under a [http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution] license. Please use them freely and share them widely--bearing in mind that they were designed for use by Michigan Publishing platforms and partners.
-	= COUNTER reports =	+	== The Michigan system ==
-	COUNTER reports show a different breakdown of the statistics than is available through the custom reports.	+	Michigan's system is the successor to a different system used before May 2007.  Data from before May 2007 was imported from the old stats system and is unreliable.
-	There are three kinds of reports available through COUNTER:	+	There are two interfaces to the Michigan statistics system (both of which have extensive help documentation explaining how to interpret the statistics):
-	* Book Report 1: Number of Successful Title Requests by Month and Title: This report counts the number of views of full texts, assuming this option is available for the publication. It will not count if a user pages through every page of an item or views every section individually.	+	* http://quod.lib.umich.edu/cgi/s/stats/public – From this page, you can generate:
-	* Book Report 2: Number of Successful Section Requests by Month and Title: This report includes views of tables of contents, individual pages, and portions of items. For SPO publications, this is probably a more useful metric of usage than Book Report 1.	+	** Custom reports showing usage from users anywhere and, if accessed from a known institution, usage from that institution's IP range
-	* Book Report 5: Total Searches by Month and Title: This report tells you how many times people used "search within this item".	+	** COUNTER reports documenting usage from users anywhere or, if accessed from a known institution, usage from that institution's IP range
		+	* http://quod.lib.umich.edu/cgi/s/stats/manager – This page is only available to those who are designated as a manager of a publication. A publishing partner can request access to the manager interface for their publication from their contact at Michigan Publishing.  From this page, you can generate:
		+	** Custom reports for any publication for which you are a manager, with statistics broken down by known institution
		+	** COUNTER reports documenting usage from users anywhere
-	These reports will contain statistics for all public titles and the restricted titles to which you have access. The statistics will be limited to information about your institution.	+	The way the COUNTER Book Reports 1 and 2, and text views, are calculated was changed on Nov. 15, 2011.  As of May 24, 2011, we are now recording section hits for encoded-text items (in addition to page-image items), allowing generation of COUNTER Book Report 2 data for these items.  '''For Michigan Publishing publications, Book Report 2 is best for all monographs and for any publications with page images; use Book Report 1 for others (non-monograph publications without page images).'''
-	All COUNTER reports are delivered by email in Excel format. Choose one or more reports to be delivered and the year for which you would like statistics.	+	As of March 21, 2012, the system includes PDF views and downloads as a type of view for most publications. (Previously these views were not included at all, and certain PDF views were erroneously included in the "pg/img" subtype from Jan. 7, 2011 to March 20, 2012.)  As of April 6, 2012, clicks on links to download a PDF are included in Book Report 1.
-	After submitting your request, you will see a confirmation page indicating that an email has been sent to you and noting if any of the requested reports are not available. You will receive an email from dlxs-info@umich.edu with the subject “DLPS COUNTER reports – Please verify request.” Follow the link in the email and enter the code that is provided, and you should receive the reports you requested within an hour.	+	Note that if a user tries to access an item to which they don't have access (because it's available only to subscribers or only to University of Michigan users), they will reach a page that says "Sorry, you aren't permitted access to this item". That page view will still be included in the usage stats because at this time we have no way of removing these visits from usage stats.
		+
		+	However, we do exclude from the statistics visits from known web crawlers, such as those operated by web search engines (like Google) and web archiving services (such as the Internet Archive), that if included would inflate usage data.
	<analytics uacct="UA-20101573-2" ></analytics>		<analytics uacct="UA-20101573-2" ></analytics>

---

Current revision

[edit] Introduction

We have two systems for tracking usage of a publication:

• Google Analytics: This provides visual and tabular data based on unique URLs. You can filter the data based on substrings of URLs, allowing an easy way to track usage of particular titles or particular system functions.
• Michigan's homegrown system: This system is used for publications hosted in DLXS on quod.lib.umich.edu. The system is aware of DLXS's URL structure and is able to equate URLs that are functionally equivalent and compile data on different types of searches and different types of browsing

[edit] Google Analytics

A publishing partner's principal contact at Michigan Publishing can get you access to Google Analytics for your publication. Just provide an email address attached to a Google Account which which you'd like access to the data to be shared.

By default we set up GA to track all web pages hosted on on quod.lib.umich.edu (where Michigan Publishing journals and other digital publications live) and, if applicable, on any pages on a domain name hosted by Michigan Publishing. If a publishing partner maintains a website on their own devoted to the publication, visits to that site are not included in our GA by default but can be added to the tracking by coordinating with your contact at Michigan Publishing.

In the summer of 2013, practicum student Clayton Hayes created a series of guides for our publishing partners who wish to use Google Analytics. These include:

• An overview of the Google Analytics dashboard and basic functions
• An overview of how GA data may be useful to journal editors and other publishing partners
• A step-by-step guide to adding your own annotations to the GA timeline for your publication
• A step-by-step guide to setting up email alerts to receive a message when specific criteria are met
• A step-by-step guide to creating custom events, that is, specific criteria that GA does not track by default, but that you want to track

These guides are available under a Creative Commons Attribution license. Please use them freely and share them widely--bearing in mind that they were designed for use by Michigan Publishing platforms and partners.

[edit] The Michigan system

Michigan's system is the successor to a different system used before May 2007. Data from before May 2007 was imported from the old stats system and is unreliable.

There are two interfaces to the Michigan statistics system (both of which have extensive help documentation explaining how to interpret the statistics):

• http://quod.lib.umich.edu/cgi/s/stats/public – From this page, you can generate:
  • Custom reports showing usage from users anywhere and, if accessed from a known institution, usage from that institution's IP range
  • COUNTER reports documenting usage from users anywhere or, if accessed from a known institution, usage from that institution's IP range
• http://quod.lib.umich.edu/cgi/s/stats/manager – This page is only available to those who are designated as a manager of a publication. A publishing partner can request access to the manager interface for their publication from their contact at Michigan Publishing. From this page, you can generate:
  • Custom reports for any publication for which you are a manager, with statistics broken down by known institution
  • COUNTER reports documenting usage from users anywhere

The way the COUNTER Book Reports 1 and 2, and text views, are calculated was changed on Nov. 15, 2011. As of May 24, 2011, we are now recording section hits for encoded-text items (in addition to page-image items), allowing generation of COUNTER Book Report 2 data for these items. For Michigan Publishing publications, Book Report 2 is best for all monographs and for any publications with page images; use Book Report 1 for others (non-monograph publications without page images).

As of March 21, 2012, the system includes PDF views and downloads as a type of view for most publications. (Previously these views were not included at all, and certain PDF views were erroneously included in the "pg/img" subtype from Jan. 7, 2011 to March 20, 2012.) As of April 6, 2012, clicks on links to download a PDF are included in Book Report 1.

Note that if a user tries to access an item to which they don't have access (because it's available only to subscribers or only to University of Michigan users), they will reach a page that says "Sorry, you aren't permitted access to this item". That page view will still be included in the usage stats because at this time we have no way of removing these visits from usage stats.

However, we do exclude from the statistics visits from known web crawlers, such as those operated by web search engines (like Google) and web archiving services (such as the Internet Archive), that if included would inflate usage data.