SUSHI Reports Registry
COUNTER Code of Practice Release 4

Release 3 Code of Practice report registry has been moved.


The SUSHI Reports Registry provides a listing of the standard report names and releases for COUNTER Code of Practice Release 4 reports that should be used when implementing the schema. Also includes a registry of non-COUNTER reports that have been developed to work with the SUSHI protocol.

COUNTER Code of Practice Release 4 Reports & Sample Files

When using the SUSHI protocol to retrieve COUNTER reports, the standardized report names as listed in the table below are to be used to ensure consistency across partners. The most current COUNTER schema will work with all the listed reports. Refer to the COUNTER Code of Practice for detailed descriptions of the reports.

The column headings map to elements and attributes in both SUSHI and COUNTER schemas as follows:

Column Heading

Use in SUSHI Schema

Use in COUNTER Schema

Name

Name attribute of the <ReportDefinition> element

Name attribute of the <Report> element

Title

Not applicable

Title attribute of the <Report> element

Release / Version

Release attribute of the <ReportDefinition> element

Version attribute of the <Report> element

 

The following table includes XML and Excel sample COUNTER payload files for each report for use in SUSHI testing. Additional files will be added as they become available.

COUNTER Reports & Sample Files

Name

Title

Description

Release

XML Sample File
Excel Sample File
Large Sample File

BR1

Book Report 1

Number of Successful Title Requests by Month and Title

4

   

BR2

Book Report 2

Number of Successful Section Requests by Month and Title

4

   

BR3

Book Report 3

Access Denied to Content Items by Month, Title, and Category

4

     

BR4

Book Report 4

Access Denied to Content Items by Month, Platform, and Category

4

     

BR5

Book Report 5

Total Searches by Month and Title

4

     

CR1

Consortium Report 1

Number of Successful Full-text Journal Article or Book Chapter Requests by Month

4

   

CR2

Consortium Report 2

Total Searches by Month and Database

4

   

CR3

Consortium Report 3

Number of Successful Multimedia Full Content Unit Requests by Month and Collection

4

   

DB1

Database Report 1

Total Searches, Result Clicks, and Record Views by Month and Database

4

 

DB2

Database Report 2

Access Denied by Month, Database, and Category

4

 

JR1

Journal Report 1

Number of Successful Full-Text Article Requests by Month and Journal

4

 

JR1 GOA

Journal Report 1 GOA

Number of Successful Gold Open Access Full-Text Article Requests by Month and Journal

4

 

JR1a

Journal Report 1a

Number of Successful Full-Text Article Requests from an Archive by Month and Journal

4

 

JR2

Journal Report 2

Access Denied to Full Text Articles by Month, Journal, and Category

4

 

JR3

Journal Report 3

Number of Successful Item Requests and Turnaways by Month, Journal, and Page-Type

4

   

JR3 mobile

Journal Report 3 Mobile

Number of Successful Item Requests by Month, Journal, and Page-Type for usage on a mobile device

4

   

JR4

Journal Report 4

Total Searches Run by Month and Collection

4

   

JR5

Journal Report 5

Number of Successful Full-Text Article Requests by Year-of-Publication (YOP) and Journal

4

 

MR1

Multimedia Report 1

Number of Successful Multimedia Full Content Unit Requests by Month and Collection

4

 

MR2

Multimedia Report 2

Number of Successful Multimedia Full Content Unit Requests by Month, Collection, and Item Type

4

 

PR1

Platform Report 1

Total Searches, Result Clicks, and Record Views by Month and Platform

4

 

TR1

Title Report 1

Number of Successful Requests for Journal Full-Text Articles and Book Sections by Month and Title

4

     

TR1 mobile

Title Report 1 Mobile

Number of Successful Requests for Journal Full-Text Articles and Book Sections by Month and Title (formatted for normal browsers/delivered to mobile devices AND formatted for mobile devices/delivered to mobile devices)

4

     

TR2

Title Report 2

Access Denied to Full-Text Items by Month, Title, and Category

4

     

TR3

Title Report 3

Number of Successful Item Requests by Month, Title, and Page-Type

4

     

TR3 mobile

Title Report 3 Mobile

Number of Successful Item Requests by Month, Title, and Page-Type (formatted for normal browsers/delivered to mobile devices and for mobile devices/delivered to mobile devices)

4

     

Other Reports

The SUSHI protocol will support the retrieval of reports other than COUNTER that meet the requirements specified in Z39.93, section 6.2, Report Naming Requirements. Registration of these reports is voluntary but strongly recommended for any reports that might cross over business partners. Registration will be on a first come first serve basis for reserving a report name. NISO members may register reports for themselves or on behalf of their business partners. To register a report, send an email to: nisohq@niso.org.

Name

Title

Description

Release / Version

Registered by

Schema location