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 Elsevier SUSHI COP5 API provides COUNTER compliant usage statistics support for Elsevier customers using ScienceDirect, Scopus, ClinicalKey, Engineering Village, or Embase.
More information about Elsevier supported reports and metrics can be found at our Librarian usage reports page.
Please see our SUSHI COP5 landing page for general information, FAQ, and details regarding SUSHI and COUNTER Code of Practice 5.1 standards.
Refer to Section 3.3.7 of the Technical Specifications for COUNTER Reports and the COUNTER_SUSHI API Specification for the full list of filters and attributes supported by the various COUNTER reports.
A complete catalog of SUSHI COP5 error codes can be found in Appendix D of the COUNTER COP5 technical standards. Returns the current status of the SUSHI COP5.1 API service. The response 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). This represents the acceptable mime types in which the response can be generated. Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is optional for this resource. This is JSON representing the current status of the Elsevier SUSHI COP5 service. This error indicates missing or incorrect parameters. This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. This is an error that occurs when the requested HTTP Method is invalid. This is an error that occurs when the requested mime type is invalid. This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. This error indicates that the service is unavailable or a fatal error has occurred. Returns a list of reports supported by the Elsevier SUSHI COP5.1 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. This represents the acceptable mime types in which the response can be generated. Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource. Elsevier customer ID associated with a customer for which the requestor is authorized to harvest reports. This is a numerical ID prefixed with either "C" or "S", depending on the customer type. This parameter is mandatory for this resource. Unique code assigned by Elsevier to grant institution, consortium or 3rd party access to this API. This parameter is mandatory for this resource. Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource. This is JSON representing the list of reports supported by the Elsevier SUSHI COP5 service. This error indicates missing or incorrect parameters. This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. This is an error that occurs when the requested HTTP Method is invalid. This is an error that occurs when the requested mime type is invalid. This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. This error indicates that the service is unavailable or a fatal error has occurred. Returns the specified COUNTER COP5.1 platform usage report for authorized requestors. The response includes metrics that vary depending upon the specific platform usage report requested. For the optional parameters of customizable report please check the Specifications for the Restful COUNTER SUSHI API. This represents the acceptable mime types in which the response can be generated. Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource. Elsevier customer ID associated with a customer for which the requestor is authorized to harvest reports. This is a numerical ID prefixed with either "C" or "S", depending on the customer type. This parameter is mandatory for this resource. Unique code assigned by Elsevier to grant institution, consortium or 3rd party access to this API. This parameter is mandatory for this resource. Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource. A filter to limit the date range of the response usage data. Must be in the format YYYY-MM-DD. This parameter is mandatory for this resource.
Example: begin_date=2018-03-09
A filter to limit the date range of the response usage data. Must be in the format YYYY-MM-DD. This parameter is mandatory for this resource.
Example: end_date=2018-03-31 This is JSON representing a platform report returned by the Elsevier SUSHI COP5 service. This error indicates missing or incorrect parameters. This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. This is an error that occurs when the requested HTTP Method is invalid. This is an error that occurs when the requested mime type is invalid. This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. This error indicates that the service is unavailable or a fatal error has occurred. Returns the specified COUNTER COP5.1 journal or book usage report for authorized requestors. The response includes metrics that vary depending on the specific title usage report requested. For the optional parameters of customizable report please check the Specifications for the Restful COUNTER SUSHI API. This represents the acceptable mime types in which the response can be generated. Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource. Elsevier customer ID associated with a customer for which the requestor is authorized to harvest reports. This is a numerical ID prefixed with either "C" or "S", depending on the customer type. This parameter is mandatory for this resource. Unique code assigned by Elsevier to grant institution, consortium or 3rd party access to this API. This parameter is mandatory for this resource. Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource. A filter to limit the date range of the response usage data. Must be in the format YYYY-MM-DD. This parameter is mandatory for this resource.
Example: begin_date=2018-03-09
A filter to limit the date range of the response usage data. Must be in the format YYYY-MM-DD. This parameter is mandatory for this resource.
Example: end_date=2018-03-31 This is JSON representing a title report returned by the Elsevier SUSHI COP5 service. This error indicates missing or incorrect parameters. This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. This is an error that occurs when the requested HTTP Method is invalid. This is an error that occurs when the requested mime type is invalid. This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. This error indicates that the service is unavailable or a fatal error has occurred. Returns the specified COUNTER COP5.1 database usage report for authorized requestors. For the optional parameters of customizable report please check the Specifications for the Restful COUNTER SUSHI API. This represents the acceptable mime types in which the response can be generated. Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource. Elsevier customer ID associated with a customer for which the requestor is authorized to harvest reports. This is a numerical ID prefixed with either "C" or "S", depending on the customer type. This parameter is mandatory for this resource. Unique code assigned by Elsevier to grant institution, consortium or 3rd party access to this API. This parameter is mandatory for this resource. Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource. A filter to limit the date range of the response usage data. Must be in the format YYYY-MM-DD. This parameter is mandatory for this resource.
Example: begin_date=2018-03-09
A filter to limit the date range of the response usage data. Must be in the format YYYY-MM-DD. This parameter is mandatory for this resource.
Example: end_date=2018-03-31 This is JSON representing a database report returned by the Elsevier SUSHI COP5 service. This error indicates missing or incorrect parameters. This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. This is an error that occurs when the requested HTTP Method is invalid. This is an error that occurs when the requested mime type is invalid. This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. This error indicates that the service is unavailable or a fatal error has occurred. 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. This represents the acceptable mime types in which the response can be generated. Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource. Elsevier customer ID associated with a customer for which the requestor is authorized to harvest reports. This is a numerical ID prefixed with either "C" or "S", depending on the customer type. This parameter is mandatory for this resource. Unique code assigned by Elsevier to grant institution, consortium or 3rd party access to this API. This parameter is mandatory for this resource. Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource. This is JSON representing a list of consortium members returned by the Elsevier SUSHI COP5 service. This error indicates missing or incorrect parameters. This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. This is an error that occurs when the requested HTTP Method is invalid. This is an error that occurs when the requested mime type is invalid. This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. This error indicates that the service is unavailable or a fatal error has occurred.