Skip to main content
Support - EBSCO Help

EBSCOhost SUSHI Web Service - FAQs

EBSCO's SUSHI Web Service is a secure model for requesting reporting data using the COUNTER 4 schema. Instead of downloading report files from EBSCOadmin, customers can automatically request a usage report by configuring your library's SUSHI client to send a request to EBSCO's SUSHI server.

EBSCO's SUSHI server packages the report and returns it to the library's SUSHI client. EBSCOhost SUSHI Web Service is compatible with the COUNTER 4 and SUSHI 1.6 standards, and provides easy compatibility with third-party applications.

 

How do I configure a request to EBSCOhost SUSHI Web Service?

You can automate the running and retrieval of COUNTER Reports using the EBSCOhost SUSHI Web Service. To access SUSHI Web Service, use the SUSHI Server URL listed on the SUSHI Authentication Screen and provide the following information in your SOAP request.

To obtain a SUSHI Server URL:

  1. Log in to EBSCOadmin at http://eadmin.ebscohost.com.
  2. Select the Reports & Statistics tab.
  3. Click on COUNTER R4 Reports.
  4. Click the SUSHI Authentication sub-tab. Be sure to provide the following information in your SOAP request:
    • Requestor ID – Validates your identity to access COUNTER usage statistics via SUSHI Web Service. Occasionally you might need to generate a new Requestor ID. (For example, a staff member leaving, etc.) To generate a new Requestor ID, click the Generate New ID button, and a new Requestor ID displays. Use the updated Requestor ID in your SOAP request. (You should also delete the Admin account for the employee who has left your institution.)

    • Customer ID – Provide the EBSCOhost Cust ID used to access COUNTER usage statistics via SUSHI Web Service.

    • Customer Name – The name that will display on your report. 

    • Requestor Email – An email address to be used to send additional information. 

    • Report Name – The COUNTER report being requested. Example: ‘JR1’.  The SUSHI Web Service supports the Journal (JR1) Report as well as the Database (DB1, DB2, and DB3) Reports.

    • Report Release – The COUNTER report release number. Enter: 3. 

    • From Date – The desired usage report starting date. Use YYYY-MM-DD format.

    • To Date – The desired usage report ending date. Use YYYY-MM-DD format.

Notes:

  • Each request can span a maximum of 12 months. 
  • EBSCOhost SUSHI Web Service allows you to generate up to 25 reports each day.
  • Innovative's Electronic Resource Management product, which can be used as an integrated module of the Millennium ILS, supports SUSHI version 1.6 for integration with EBSCOhost.
What COUNTER Reports in EBSCOadmin does SUSHI support?

SUSHI 1.6 supports the following COUNTER reports in EBSCOadmin:

  • Journal Report 1
  • Journal Report 5
  • Database Report 1
  • Database Report 2
  • Platform Report 1
  • Book Report 1
  • Book Report 2
  • Book Report 3
  • Consortium Report 1
  • Consortium Report 2

All reports (with the exception of CR1 and CR2) can also be accessed online through EBSCOadmin via the "COUNTER R4" menu tab.

Q. Where can I find information on setting up a SUSHI Client to access EBSCOhost Statistics?

The following page has helpful information on setting up and configuring a SUSHI client to access usage statistics.

Getting Started with SUSHI: For Developers of SUSHI Servers