SUSHI reporting

What is SUSHI?

SUSHI is a protocol developed to automate the retrieval of COUNTER usage reports into local systems from SUSHI-compliant providers like Social Explorer. Without SUSHI, you would have to manually download usage statistics from our admin panel.  

You can enable access to SUSHI at your library through its electronic resource management system or other usage statistics reporting services. More about how to implement SUSHI protocol can be found on the SUSHI for Librarians website.

Social Explorer offers COUNTER Release 5 compliant SUSHI reports.

Getting started with SUSHI

To set up SUSHI requests, you will require your administrative usage statistics credentials:

No API Key is required for Social Explorer.

How to find your usage credentials

  1. If you are already able to access usage statistics directly from the Social Explorer site using your individual account, you should see the My Organizations item when you click on your avatar in the top-right corner.
  2. Your Customer ID and Requester ID will be listed in the tab labeled “SUSHI API".

Please contact us if you don’t have access to these credentials.

COUNTER R5 SUSHI Request URLs

You may be required to include the Social Explorer API endpoints when setting up SUSHI R5 protocol in your usage statistics service. The table below shows the four endpoints available on the Social Explorer SUSHI API. Each endpoint is designed as per the COUNTER Code of Practice.

Path Social Explorer URL Description

  GET  /status

 https://www.socialexplorer.com/
 sushi/status/

Returns the current status of the Social Explorer SUSHI R5 service.

  GET  /reports

 https://www.socialexplorer.com/
 sushi/reports

Returns a list of the COUNTER R5 reports supported by Social Explorer.

  GET  /reports/{report_id} 

 https://www.socialexplorer.com/
 sushi/reports/{report_code}

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 Social Explorer.

  GET  /members

 https://www.socialexplorer.com/
 sushi/members

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

SUSHI Parameters and Attributes

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

Name Description

report_type

Which SUSHI report

customer_id

Institution the report is for

requestor_id

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

 

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.

Looking for COUNTER 5 overview? For more information on Social Explorer's COUNTER 5 implementation, please visit our Usage Reports Overview: COUNTER 5 page.