SUSHI COP5 API

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, or Engineering Village.

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 standards.

Refer to Section 3.3.8 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 F of the COUNTER COP5 technical standards.

Summary

Resource Method Description
https://api.elsevier.com/sushi/status/ GET
SUSHI COP5 Status: Returns the current status of the SUSHI COP5 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).
https://api.elsevier.com/sushi/reports/ GET
SUSHI COP5 Reports: Returns a list of reports supported by the Elsevier 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.
https://api.elsevier.com/sushi/reports/{platform} GET
SUSHI COP5 Platform Reports: Returns the specified COUNTER COP5 platform usage report for authorized requestors. The response includes metrics that vary depending upon the specific platform usage report requested.
https://api.elsevier.com/sushi/reports/{title} GET
SUSHI COP5 Title Reports: Returns the specified COUNTER COP5 journal or book usage report for authorized requestors. The response includes metrics that vary depending on the specific title usage report requested.
https://api.elsevier.com/sushi/reports/{database} GET
SUSHI COP5 Database Reports: Returns the specified COUNTER COP5 database usage report for authorized requestors.
https://api.elsevier.com/sushi/members/ GET
SUSHI COP5 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.

Resources


https://api.elsevier.com/sushi/status/

SUSHI COP5 Status: Returns the current status of the SUSHI COP5 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).

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: application/json
options: application/json
This represents the acceptable mime types in which the response can be generated.

query params
requestor_id xsd:string Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource.
customer_id xsd:string 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 optional for this resource.
platform xsd:string
options: sc, sd, ev
Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is optional for this resource.

responses
status:
200
representations
application/json SUSHI COP5 JSON Response: This is JSON representing the current status of the Elsevier SUSHI COP5 service. JSON Example
status:
400
representations
application/json Invalid Request: This error indicates missing or incorrect parameters. Invalid Request Example
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). Authentication Error Example
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization/Entitlements Error Example
status:
405
representations
application/json Invalid Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
application/json Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeeded Example
status:
500
representations
application/json Generic Error: This error indicates that the service is unavailable or a fatal error has occurred. Generic Error Example

https://api.elsevier.com/sushi/reports/

SUSHI COP5 Reports: Returns a list of reports supported by the Elsevier 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.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: application/json
options: application/json
This represents the acceptable mime types in which the response can be generated.

query params
requestor_id xsd:string Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource.
customer_id xsd:string 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. Optional parameter for this resource.
platform xsd:string
options: sc, sd, ev
Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource.

responses
status:
200
representations
application/json SUSHI COP5 JSON response: This is JSON representing the list of reports supported by the Elsevier SUSHI COP5 service. JSON example
status:
400
representations
application/json Invalid Request: This error indicates missing or incorrect parameters. Invalid Request Example
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). Authentication Error Example
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization/Entitlements Error Example
status:
405
representations
application/json Invalid Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
application/json Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeeded Example
status:
500
representations
application/json Generic Error: This error indicates that the service is unavailable or a fatal error has occurred. Generic Error Example

https://api.elsevier.com/sushi/reports/{platform}

SUSHI COP5 Platform Reports: Returns the specified COUNTER COP5 platform usage report for authorized requestors. The response includes metrics that vary depending upon the specific platform usage report requested.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: application/json
options: application/json
This represents the acceptable mime types in which the response can be generated.

query params
requestor_id xsd:string Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource.
customer_id xsd:string 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.
platform xsd:string
options: sc, sd, ev
Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource.
begin_date xsd:string 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

end_date xsd:string 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

responses
status:
200
representations
application/json SUSHI COP5 JSON response: This is JSON representing a platform report returned by the Elsevier SUSHI COP5 service. JSON example
status:
400
representations
application/json Invalid Request: This error indicates missing or incorrect parameters. Invalid Request Example
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). Authentication Error Example
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization/Entitlements Error Example
status:
405
representations
application/json Invalid Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
application/json Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeeded Example
status:
500
representations
application/json Generic Error: This error indicates that the service is unavailable or a fatal error has occurred. Generic Error Example

https://api.elsevier.com/sushi/reports/{title}

SUSHI COP5 Title Reports: Returns the specified COUNTER COP5 journal or book usage report for authorized requestors. The response includes metrics that vary depending on the specific title usage report requested.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: application/json
options: application/json
This represents the acceptable mime types in which the response can be generated.

query params
requestor_id xsd:string Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource.
customer_id xsd:string 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.
platform xsd:string
options: sc, sd, ev
Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource.
begin_date xsd:string 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

end_date xsd:string 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

responses
status:
200
representations
application/json SUSHI COP5 JSON response: This is JSON representing a title report returned by the Elsevier SUSHI COP5 service. JSON Example
status:
400
representations
application/json Invalid Request: This error indicates missing or incorrect parameters. Invalid Request Example
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). Authentication Error Example
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization/Entitlements Error Example
status:
405
representations
application/json Invalid Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
application/json Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeeded Example
status:
500
representations
application/json Generic Error: This error indicates that the service is unavailable or a fatal error has occurred. Generic Error Example

https://api.elsevier.com/sushi/reports/{database}

SUSHI COP5 Database Reports: Returns the specified COUNTER COP5 database usage report for authorized requestors.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: application/json
options: application/json
This represents the acceptable mime types in which the response can be generated.

query params
requestor_id xsd:string Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource.
customer_id xsd:string 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.
platform xsd:string
options: sc, sd, ev
Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource.
begin_date xsd:string 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

end_date xsd:string 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

responses
status:
200
representations
application/json SUSHI COP5 JSON response: This is JSON representing a database report returned by the Elsevier SUSHI COP5 service. JSON example
status:
400
representations
application/json Invalid Request: This error indicates missing or incorrect parameters. Invalid Request Example
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). Authentication Error Example
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization/Entitlements Error Example
status:
405
representations
application/json Invalid Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
application/json Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeeded Example
status:
500
representations
application/json Generic Error: This error indicates that the service is unavailable or a fatal error has occurred. Generic Error Example

https://api.elsevier.com/sushi/members/

SUSHI COP5 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.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: application/json
options: application/json
This represents the acceptable mime types in which the response can be generated.

query params
requestor_id xsd:string Elsevier API key associated with the requestor, whether it be an institution, third party, or consortium. This parameter is mandatory for this resource.
customer_id xsd:string 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.
platform xsd:string
options: sc, sd, ev
Elsevier platform code associated with the product for which the requestor wishes to harvest reports. This parameter is mandatory for this resource.

responses
status:
200
representations
application/json SUSHI COP5 JSON Response: This is JSON representing a list of consortium members returned by the Elsevier SUSHI COP5 service. JSON Example
status:
400
representations
application/json Invalid Request: This error indicates missing or incorrect parameters. Invalid Request Example
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (API key). Authentication Error Example
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization/Entitlements Error Example
status:
405
representations
application/json Invalid Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
application/json Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeeded Example
status:
500
representations
application/json Generic Error: This error indicates that the service is unavailable or a fatal error has occurred. Generic Error Example