Skip to main content

Standardized Usage Statistics Harvesting Initiative (SUSHI) Protocol (ANSI/NISO Z39.93-2014)

WHAT IT IS ...

  • An ANSI/NISO Standard
  • Defines automated request and response model for harvesting e-resource usage data
  • Designed to work with COUNTER, the most frequently retrieved usage reports

WHY YOU SHOULD USE IT …

  • It replaces the time-consuming user-mediated collection of usage data reports
  • The protocol is generalized and extensible, meaning it can be used to retrieve a variety of usage reports

Note on COUNTER R5

COUNTER R5 is RESTful and returns JSON responses so there is no XML and thus no XSD.
 
Please refer to COUNTER R5 CoP, Section 8, which also references the Swagger documentation at https://app.swaggerhub.com/apis/COUNTER
 
Note: many providers will offer their own Swagger or other API documentation to describe their specific support for COUNTER R5 SUSHI.

Section pages

Documents

Related Publications

Recommended Practice

NISO RP-14-2014, NISO SUSHI Protocol: COUNTER-SUSHI Implementation Profile

Defines a practical implementation structure to be used in the creation of reports and services related to harvesting COUNTER reports using the NISO SUSHI Protocol.

ISBN: 978-1-937522-45-2
Document Details
Standard

ANSI/NISO Z39.93-2014 The Standardized Usage Statistics Harvesting Initiative (SUSHI) Protocol

This standard defines an automated request and response model for the harvesting of electronic resource usage data utilizing a Web services framework that can replace the user-mediated collection of usage data reports. It was designed as a generalized protocol extensible to a variety of usage reports. An extension designed specifically to work with COUNTER reports is provided.

The standard is built on SOAP (Simple Object Access Protocol) for transferring request and response messages. The GetReport method is used for transferring ReportRequest as the input message and returning ReportResponse as the output message.

The standard is accompanied by a versioned Web Services Description Language (WSDL) to describe the Web service namespace and operations, and an XML schema constraining the syntax of the SUSHI transaction. Rules for report naming are outlined and complemented by an external reports registry, which provides for the definition of both COUNTER and non-COUNTER reports.

ISBN: 978-1-937522-47-6
Document Details
Standard

ANSI/NISO Z39.7-2013 Information Services and Use: Metrics & Statistics for Libraries and Information Providers Data Dictionary

This standard identifies categories for basic library statistical data reported at the national level, and provides associated definitions of terms. In doing so it deals with the following areas: reporting unit and target population, human resources, collection resources, infrastructure, finances, and services. In addition, the standard identifies new measures associated with networked services, databases, and performance. The standard is not intended to be comprehensive in scope. Instead, it presents a framework for comparable library data by describing common elements pertaining to libraries of various types in the US. It does not address detailed statistics for specific areas where it seems more appropriate for experts in those areas to make recommendations (e.g., music, government documents, maps).

ISBN: 978-1-937522-15-5
Document Details

Committee Roster

The SUSHI Standing Committee provides ongoing support for SUSHI and its users.

Co-chairs

Oliver Pesch

Chief Product Strategist
EBSCO Information Services

Members

Chan Li

California Digital Library (CDL)