On this page:
For more information on JSTOR's COUNTER implementation, please visit Usage Reports: COUNTER 5.1 Overview.
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.
Getting started with SUSHI
To set up SUSHI requests you need your administrative usage statistics credentials. No API Key is required for JSTOR.
| Base or Server URL | https://www.jstor.org/sushi/r51/ |
| Customer ID | Your institution's JSTOR account code |
| Requester ID | Your admin username |
How to find your usage credentials:
- Log into JSTOR Admin with a personal account that has administrative permissions.
- Not an admin yet? See Accessing JSTOR Admin to get started.
- Open the Reports drop-down menu in the sidebar and select COUNTER 5.1.
- Your Customer ID and Requester ID will be listed in the box labeled SUSHI Account Information.
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: Consortia administrators can run reports for any of the members of that consortium once they have administrative access to the consortia.
COUNTER 5.1 SUSHI request URLs
You may be required to include the JSTOR API endpoints when setting up SUSHI harvesting in your usage statistics service. The table below shows the four endpoints available on the JSTOR SUSHI 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/r51/status/ |
Returns the current status of the JSTOR SUSHI service. |
|
GET /reports |
https://www.jstor.org/sushi/r51/reports |
Returns a list of the COUNTER reports supported by JSTOR. |
|
GET /reports/{report_id} |
https://www.jstor.org/sushi/r51/reports/{report_code} |
Report request. Refer to the Project COUNTER's SUSHI API Specification for sample SUSHI requests.
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/r51/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 |
For more information:
- Visit the COUNTER_SUSHI API Specification for example requests.
- Refer Section 8.0 SUSHI for Automated Report Harvesting of the COUNTER Code of Practice Release 5.1.
- Refer to Appendix D of the COUNTER Code of Practice Release 5.1 for error handling and exceptions.
SUSHI compression
JSTOR supports GZIP compression for SUSHI harvesting. It is recommended that JSTOR SUSHI clients use compression when requesting reports to receive their reports faster.
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/r51/reports/?requestor_id=reqid&customer_id=custid
additional header: Accept-Encoding: gzip
- See HTTP Compression on Wikipedia for further information.
Frequently Asked Questions
Can I still access COUNTER 5 reports via SUSHI?
Yes, we will provide access to historical COUNTER 5 data through March 2027 at the following endpoint: https://www.jstor.org/sushi/ (Please note, this URL does not contain a release number.)
The COUNTER 5 endpoint also supports an optional “platform” parameter to support access to historical usage data from the Artstor platform, which was retired on August 1, 2024. Accepted values for the “platform” parameter are "jstor" and "artstor".
Can I still access COUNTER 4 reports via SUSHI?
No, COUNTER 4 support for SUSHI functionality has been retired as of February 2022.