What’s in this article:
- What is SUSHI?
- Getting started with SUSHI
- COUNTER R5 SUSHI Request URLs
- Requesting file compression
- Is SUSHI COUNTER 4 still available?
Looking for COUNTER 5 overview? For more information on JSTORs COUNTER 5 implementation, please visit our COUNTER 5 Usage Reports page.
What is SUSHI?
SUSHI is a protocol developed to automate the harvesting of COUNTER reports from SUSHI-compliant providers, such as JSTOR.
SUSHI access is something you can enable at your library with your electronic resource management system or other usage statistic reporting services. More about how to implement SUSHI harvesting can be found on the SUSHI for Librarians website.
When you’re ready to add JSTOR reports to your SUSHI to your list of providers, below is the information you need to get started.
JSTOR is now offering COUNTER Release 5 compliant SUSHI reports, and this page focuses on the COUNTER 5 Release. For more information about COUNTER 4 SUSHI Reports on JSTOR, see the SUSHI COUNTER Release 4 support article.
Getting started with SUSHI
To set up SUSHI requests you need your administrative usage statistics credentials:
- Customer ID (JSTOR account code)
- Requester ID (admin username)
How to find your usage credentials:
- If you already are able to access usage statistics directly from the JSTOR site using your MyJSTOR account, log in to the COUNTER R4 usage statistics interface.
- Your Customer ID and Requester ID will be listed in the box labeled “Sushi Account Information.”
Please contact us if you don’t have access to these credentials.
Note: The same Requestor ID and Customer ID can be used for both SUSHI Release 4 (R4) and SUSHI Release 5 (R5) on JSTOR.
Usage Statistics Collection for Vendors: If you are setting up SUSHI harvesting on behalf of an institution or library, you will need to contact us for the library's credentials.
Usage Statistics Collection for Consortia: In SUSHI R5 consortia administrators can run reports for any of the members of that consortium once they have administrative access to the consortia (In C4, administrator accounts had to be attached to each member individually).
COUNTER R5 SUSHI Request URLs
You may be required to include the JSTOR API endpoints when setting up SUSHI R5 harvesting in your usage statistics service. The table below shows the four endpoints available on the JSTOR SUSHI R5 API. Each endpoint is designed per the COUNTER Code of Practice. Specific instructions should be available from your usage statistics harvesting service provider.
Returns the current status of the JSTOR SUSHI R5 service.
Returns a list of the COUNTER R5 reports supported by JSTOR.
Report request. Please refer to the Project COUNTERs SUSHI API for sample SUSHI request. /reports will return a list of the report codes supported on JSTOR.
Returns a list of the institution accounts that are members of a consortium account on JSTOR
To get an idea of what SUSHI R5 requests look like, please visit the COUNTER_SUSHI API. For more details, please refer to the COUNTER R5 Code of Practice section 8.0 SUSHI for Automated Report Harvesting. For guidelines and error handling and exceptions, please see Appendix F of the Release 5 Code of Practice.
SUSHI R5 Compression
JSTOR supports compression in SUSHI R5. It is recommended that JSTOR SUSHI clients use compression when requesting reports to receive their reports faster. JSTOR supports GZIP compression for SUSHI R5.
To request compressed files:
- Select your preference to receive compressed server responses through the Accept-Encoding HTTP header field with a value of "gzip".
- For example:
additional header: Accept-Encoding: gzip
- See HTTP Compression on Wikipedia for further information.
Can I still access COUNTER R4 reports via SUSHI?
Yes, R4 reports are available via the R4 SUSHI implementation at:
Note that Ex Libris UStat and Alma customers must request SUSHI R4 reports via:
You can read more about SUSHI C4 in our SUSHI COUNTER Release 4 support article.