Skip to Main Content

SUSHI reports: COUNTER 5 overview

  • Updated

On this page:

Looking for COUNTER 5 overview? For more information on JSTOR 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 Project COUNTER website.

When you’re ready to add JSTOR reports to your SUSHI list of providers, you'll find the information you need to get started below.

JSTOR offers COUNTER Release 5 compliant SUSHI reports, and this page focuses on the COUNTER 5 Release. 

Getting started with SUSHI

To set up SUSHI requests you need your administrative usage statistics credentials:

Base or Server URL https://www.jstor.org/sushi/
Customer ID Your institution's JSTOR account code
Requester ID Your admin username

No API Key is required for JSTOR.

How to find your usage credentials:

  1. If you already are able to access usage statistics directly from the JSTOR site using your individual account, log in to the COUNTER usage statistics interface.
  2. 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 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.

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 has been designed in coordination with the COUNTER Code of Practice. Specific instructions may be available from your usage statistics harvesting service provider.

Path

JSTOR URL

Description

GET  /status

https://www.jstor.org/sushi/status/

Returns the current status of the JSTOR SUSHI R5 service.

GET  /reports

https://www.jstor.org/sushi/reports

Returns a list of the COUNTER R5 reports supported by JSTOR.

GET  /reports/{report_id}

https://www.jstor.org/sushi/reports/{report_code}

Report request. Refer to the Project COUNTERs SUSHI API for sample SUSHI request.

 

This request will return a "Report Queued for Processing" response (Exception Code 1011). Please wait at least one (1) hour between report requests to allow time for report files to be generated.

GET  /members

https://www.jstor.org/sushi/members

Returns a list of the institution accounts that are members of a consortium account on JSTOR.

SUSHI Parameters and Attributes

You can use the following parameters to construct a SUSHI request URL from JSTOR's API:

Parameter

Description

report_type

Type of report being being requested ("pr", "ir_m1", etc.).

customer_id

 Institution JSTOR account code. Identifies the institution to provide report data for.

requestor_id

Admin username. Who is making the report request, must be an administrator of the institution.

begin_date

Usage start date in the form of yyyy-mm-dd or yyyy-mm

end_date

Usage end date in the form of yyyy-mm-dd or yyyy-mm

platform

An optional parameter, the name of the platform the report data is being requested for. Accepted values are "jstor" and "artstor".

If this parameter is omitted, requests to the JSTOR endpoint (https://www.jstor.org/sushi/) will default to JSTOR platform usage. JSTOR platform usage includes, but is not limited to, Artstor on JSTOR content. For usage reporting isolated to Artstor on JSTOR collections, please see Usage Reports for Artstor on JSTOR.

Requests to the Artstor endpoint (https://report.artstor.org/sushi/) will default to Artstor platform usage. The Artstor platform was retired on August 1, 2024, but historical usage data can still be requested via the Artstor endpoint or the JSTOR endpoint (with the "artstor" platform parameter) after this date.

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:
  method: GET
  url: https://www.jstor.org/sushi/reports/?requestor_id=reqid&customer_id=custid
  additional header: Accept-Encoding: gzip

Can I still access COUNTER R4 reports via SUSHI?

No, COUNTER 4 support for SUSHI functionality has been retired as of February 2022.

Articles in this section