Citation Overview API

This represents the interfaces to retrieve document citation counts (SCOPUS content) broken down by year, with the option to exclude self-citations. To retrieve the total citations count for a document, use the Abstract Citation Count API.



The following chart shows the Citation Overview Views.

Summary

Resource Method Description
https://api.elsevier.com/content/abstract/citations GET
Citation Overview API: This represents a retrieval of citation metadata, including counts and citation summaries, for specific documents (SCOPUS content).

Resources


https://api.elsevier.com/content/abstract/citations

Citation Overview API: This represents a retrieval of citation metadata, including counts and citation summaries, for specific documents (SCOPUS content).

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: application/json
options: application/json, text/xml, application/xml
This represents the acceptable mime types for which the response can be generated.
Authorization xsd:string This header field contains the OAuth bearer access token, where the format of the field is "Bearer <token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements. The Authorization field overrides X-ELS-Authtoken.
X-ELS-APIKey xsd:string
(required)
This represents a unique application developer key providing access to resource.
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this key is used to validate the credentials needed to access content in this resource.
X-ELS-ReqId xsd:string This is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. Note that this should be a unique identifier for the client, and used to track a single transaction.
X-ELS-ResourceVersion xsd:string Represents the version of the resource that should be received.

query params
httpAccept xsd:string
options: application/json, text/xml, application/xml
Override for HTTP header Accept, this represents the acceptable mime types for which the response can be generated.
access_token xsd:string Override for HTTP header Authorization, this contains the OAuth bearer access token, where the format of the field is "<token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements.
apiKey xsd:string Override for HTTP header X-ELS-APIKey, this represents a unique application developer key providing access to resource.
reqId xsd:string Override for HTTP header X-ELS-ReqId, this is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. Note that this should be a unique identifier for the client, and used to track a single transaction.
ver xsd:string Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
start xsd:string

Numeric value representing the results offset (i.e. starting position for the search results). The maximum for this value is a system-level default (varies with search cluster) minus the number of results requested. If not specified the offset will be set to zero (i.e. first search result)



ex. start=5
count xsd:string

Numeric value representing the maximum number of results to be returned for the search. If not provided this will be set to a system default based on service level.

In addition the number cannot exceed the maximum system default ?? if it does an error will be returned.



ex. count=10
view xsd:string
default: STANDARD
options: STANDARD
The following chart shows the Citation Overview Views.
field xsd:string

This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view).

Multiple fields can be specified, delimited by commas.
sort xsd:string
options: sort-year, rowTotal


Represents the sort field name and order. A plus in front of the sort field name indicates ascending order, a minus indicates descending order. If sort order is not specified (i.e. no + or -) then the order defaults to ascending (ASC).



Only one sort field can be specified at a time.



+/-{field name}



ex. sort=+sort-year
date xsd:string

Represents the date range associated with the search, with the lowest granularity being year.



ex. date=2002-2007
citation xsd:string
options: exclude-self, exclude-books


Allows for the exclusion of self-citations. The default behavior is to include all citations.

author_id xsd:string

Exclude citations for specified author. Ignored if citation=exclude-books

One or more author identifiers can be requested.

scopus_id xsd:string

One or more document identifiers can be requested.

doi xsd:string

One or more document identifiers can be requested.

pii xsd:string

One or more document identifiers can be requested.

pubmed_id xsd:string

One or more document identifiers can be requested.

responses
status:
200
representations
application/json Citation Overview JSON Response: This is JSON representing the requested resource. abstractCitationResp.json
status:
200
representations
text/xml Citation Overview XML Response: This is XML representing the requested resource. abstractCitationResp.xml
status:
200
representations
application/xml Citation Overview XML Response: This is XML representing the requested resource. abstractCitationResp.xml
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. invalidRequest.xml
status:
401
representations
text/xml Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey). authError.xml
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. invalidHttpMethod.xml
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. invalidAcceptHeader.xml
status:
429
representations
text/xml Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. quotaExceeded.xml
status:
500
representations
text/xml Generic Error: This is a general purpose error condition. genericError.xml