SUSHI and COUNTER
My notes about COUNTER and SUSHI
COUNTER: Counting Online Usage of Networked Electronic Resources. projectcounter.org
SUSHI: Standardized Usage Statistics Harvesting Initiative. www.niso.org/workrooms/sushi/
COUNTER is a standard used by libraries and publishers to report online usage statistics. The reports can be in CSV, spreadsheets, or XML. There are several types of reports; Journal, Database, and Consortium Reports. All reports are monthly.
SUSHI is a Web Service (SOAP) standard which allows requesting a COUNTER report in XML format. The web service request specifies what COUNTER report is needed, while the response will contain (embedded) the report. See SUSHI Tutorial.
The SUSHI web service should validate the request before responding. Validations could include:
- Client IP address. As a security measure.
- Customer ID.
- Report type.
- Date range.
Sample SUSHI Request
(Items in bold are required)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:coun="http://www.niso.org/schemas/sushi/counter"
xmlns:sus="http://www.niso.org/schemas/sushi">
<soapenv:Header/>
<soapenv:Body>
<coun:ReportRequest Created="?" ID="?">
<sus:Requestor>
<!-- ID contains the domain of service making request, e.g. http://www.x.com
It also can be used for authentication, e.g. userName/password
-->
<sus:ID>demo</sus:ID>
<sus:Name>?</sus:Name>
<sus:Email>?</sus:Email>
</sus:Requestor>
<sus:CustomerReference>
<sus:ID>demo</sus:ID> <!-- could be similar to Requestor ID ->
<!--Optional:-->
<sus:Name>?</sus:Name>
</sus:CustomerReference>
<sus:ReportDefinition Name="JR1" Release="3"> <!-- release is version# -->
<sus:Filters>
<sus:UsageDateRange>
<sus:Begin>2009-01-06</sus:Begin>
<sus:End>2009-01-06</sus:End>
</sus:UsageDateRange>
</sus:Filters>
</sus:ReportDefinition>
</coun:ReportRequest>
</soapenv:Body>
</soapenv:Envelope>
Sample SUSHI Response (Error)
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/1999/XMLSchema" >
<SOAP-ENV:Body>
<ReportResponse ID="demo"
xsi:schemaLocation="http://www.niso.org/schemas/sushi/counter
http://www.niso.org/schemas/sushi/counter_sushi3_0.xsd"
Created="2010-06-02T19:40:14Z"
xmlns="http://www.niso.org/schemas/sushi/counter"
xmlns:s="http://www.niso.org/schemas/sushi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<s:Requestor>
<s:ID>demo</s:ID>
<s:Name>?</s:Name>
<s:Email>?</s:Email>
</s:Requestor>
<s:CustomerReference>
<s:ID>?</s:ID>
<s:Name>?</s:Name>
</s:CustomerReference>
<s:ReportDefinition Name="JR1" Release="3">
<s:Filters>
<s:UsageDateRange>
<s:Begin>2008-01-01</s:Begin>
<s:End>2008-03-01</s:End>
</s:UsageDateRange>
</s:Filters>
</s:ReportDefinition>
<Exception Created="2010-06-02T19:40:14Z" xmlns="http://www.niso.org/schemas/sushi">
<Number>2010</Number>
<Severity>Error</Severity>
<Message>The Requestor ID (demo) has not been authorized to harvest usage for the institution.</Message>
</Exception>
</ReportResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample SUSHI Response (success)
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/1999/XMLSchema" >
<SOAP-ENV:Body>
<ReportResponse ID="demo"
xsi:schemaLocation="http://www.niso.org/schemas/sushi/counter
http://www.niso.org/schemas/sushi/counter_sushi3_0.xsd"
Created="2010-06-02T20:57:05Z"
xmlns="http://www.niso.org/schemas/sushi/counter"
xmlns:s="http://www.niso.org/schemas/sushi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<s:Requestor>
<s:ID>demo</s:ID>
<s:Name>?</s:Name>
<s:Email>?</s:Email>
</s:Requestor>
<s:CustomerReference>
<s:ID>demo</s:ID>
<s:Name>?</s:Name>
</s:CustomerReference>
<s:ReportDefinition Name="JR1" Release="3">
<s:Filters>
<s:UsageDateRange>
<s:Begin>2009-01-06</s:Begin>
<s:End>2009-01-06</s:End>
</s:UsageDateRange>
</s:Filters>
</s:ReportDefinition>
<!-- next is the COUNTER report -->
<Report>
<Report Created="2010-06-02T20:57:06Z"
Title="Number of Successful Full-Text Article Requests by Month and Journal"
ID="JR1:3" Version="3"
xmlns="http://www.niso.org/schemas/counter">
<Vendor>
<Name>Project Euclid</Name>
<ID>37e194bf-898e-4884-aa14-5f73e4c14ae5</ID>
<Contact>
<Contact>Project Euclid Support</Contact>
<E-mail>EUCLID-L@cornell.edu</E-mail>
</Contact>
<WebSiteUrl>http://www.projecteuclid.org</WebSiteUrl>
</Vendor>
<Customer>
<Name>Demo Institution</Name>
<ID>demo</ID>
<WebSiteUrl/>
<!-- repeating ReportItems start next -->
<ReportItems>
<ItemIdentifier>
<Type>ISSN</Type>
<Value>1085-3375</Value>
</ItemIdentifier>
<ItemPlatform>Project Euclid</ItemPlatform>
<ItemPublisher>Hindawi Publishing Corporation</ItemPublisher>
<ItemName>Abstract and Applied Analysis</ItemName>
<ItemDataType>Journal</ItemDataType>
<ItemPerformance>
<Period>
<Begin>2009-01-01</Begin>
<End>2009-01-31</End>
</Period>
<Category>Requests</Category>
<Instance>
<MetricType>ft_total</MetricType>
<Count>586</Count>
</Instance>
</ItemPerformance>
<ItemPerformance>
<Period>
<Begin>2009-01-01</Begin>
<End>2009-01-31</End>
</Period>
<Category>Requests</Category>
<Instance>
<MetricType>ft_pdf</MetricType>
<Count>586</Count>
</Instance>
</ItemPerformance>
<ItemPerformance>
<Period>
<Begin>2009-01-01</Begin>
<End>2009-01-31</End>
</Period>
<Category>Requests</Category>
<Instance>
<MetricType>ft_html</MetricType>
<Count>0</Count>
</Instance>
</ItemPerformance>
</ReportItems>
<!-- more ReportItems -->
</Customer>
</Report>
</Report>
</ReportResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
-
ahabra posted this
