SUSHI COUNTER COP5 API

General Information

The Standard Usage Statistics Harvesting Initiative protocol (SUSHI) has been established as the ANSI/NISO Z39.93-2014 standard for API support of COUNTER compliant usage statistics.

The SUSHI COP5 API provides RESTful API support in JSON format for COUNTER COP5 usage statistics and reports. For more information about the SUSHI and COUNTER COP5 standards, please see the following Project COUNTER pages:

Interactive examples of the SUSHI COP5 API and supported methods can be found on the COUNTER_SUSHI5_0 API Swagger web page.


Elsevier SUSHI COP5 Information

The Elsevier SUSHI COP5 API provides COUNTER compliant usage statistics support for Elsevier customers using ScienceDirect, Scopus, or Engineering Village.

The Elsevier Librarian usage reports page provides more information about Elsevier supported reports and metrics.

Who can use the Elsevier COUNTER COP5 SUSHI API?

Anyone who has obtained a SUSHI API key and has been granted access to use the API key to harvest COUNTER Code of Practice 5 compliant usage statistics on behalf of Elsevier supported platform users.

Where do I start for Elsevier SUSHI COP5 support?

The Elsevier Developer Portal contains API specifications and guides to help you get started with the Elsevier SUSHI COP5 API. This page serves as a central hub for those resources.

Additionally, if you're a new integrator, you can obtain an API key from the Developer Portal which must then be configured for your particular type of SUSHI support. If you don't already have an Elsevier user ID, you will need to register prior to obtaining an API key. Once obtained, please contact Integration Support with a detailed description of your SUSHI support needs to have your API key properly configured.

If you're an existing COP4 integrator migrating to COP5, Elsevier will provide you with a preconfigured API key and instructions on how to proceed with your migration.

What do I get access to with my API key?

Your API key will be your requestor_id value when making SUSHI API requests. With the API key you will be able to use the GET /status and GET /reports methods by default.

To use the GET /members and GET /reports/{reportID} methods, your API key must have been properly configured for your type of access and the customer_id of the Elsevier customers you need to support. NOTE: The customer_id is the 10 digit Elsevier account number starting with 'C' for institutions and 'S' for consortium accounts.

Who do I contact for API support?

Please e-mail your questions to Integration Support. If you already have an API key, please include it in the e-mail. For Elsevier COP5 reports and metrics related questions, please see the Librarian usage reports page.

What are the benefits of using the SUSHI COP5 API?

The SUSHI COP5 API replaces the time consuming manual collection of usage data reports. The API complies with ANSI/NISO and COUNTER standards and provides generalized and reliable support for COUNTER COP5 usage reports.


Elsevier SUSHI COP5 Methods

Elsevier supports status, members, reports, and all DR, TR, and PR report methods. Elsevier does not support IR report methods.

Method Resource URI Description
GET /status https://api.elsevier.com/sushi/status Returns the current status of the SUSHI COP5 API service. This path returns a message includes the operating status of the API, the URL to the service's entry in the Register of COUNTER Compliant Content Providers, and an array of service alerts (if any).
GET /reports https://api.elsevier.com/sushi/reports Returns a list of reports supported by the SUSHI COP5 API service. The response includes an array of reports, including the report identifier, the release number, the report name, a description, a list of supported report filters, and a list of supported report attributes.
GET /reports/{reportID} https://api.elsevier.com/sushi/reports/{reportID} Each supported report will have its own path, e.g. GET /reports/TR_B1 for book requests (excluding "OA_Gold"), GET /reports/TR_J1 for journal requests (excluding "OA_Gold"), etc.
GET /members https://api.elsevier.com/sushi/members Returns the list of consortium members or sites for multi-site customers. The response includes an array of customer account information, including for each member the customer ID (to use when requesting COUNTER reports), the requestor ID (to use when requesting COUNTER reports), the customer account name, and additional identifiers for the organization (if any). Note that if the customer ID specified in the parameter for the /members path is not a multi-site organization, then the response will simply return the details for that customer.

Examples

  1. GET /status
    https://api.elsevier.com/sushi/status?requestor_id={requestor_id}&platform={platform}
  2. GET /members
    https://api.elsevier.com/sushi/members?requestor_id={requestor_id}&platform={platform}&customer_id={customer_id}
  3. GET /reports
    https://api.elsevier.com/sushi/reports?requestor_id={requestor_id}&platform={platform}&customer_id={customer_id}
  4. GET /reports/{reportID}
    https://api.elsevier.com/sushi/reports/pr?requestor_id={requestor_id}&platform={platform}&customer_id={customer_id}&begin_date=2018-03-01&end_date=2018-03-31

Elsevier SUSHI COP5 API Specifications

More detailed Elsevier SUSHI COP5 API technical specifications are available at the Elsevier Developer Portal SUSHI COP5 documentation page.

For more information regarding the SUSHI COP5 API standards, please see the Project COUNTER Section 8.0 SUSHI for Automated Report Harvesting and Specifications for the RESTful COUNTER SUSHI API. Additional links are provided on the Elsevier SUSHI COP5 API specification page.