Citation Overview
citation_overviewRetrieve yearly citation counts and summaries for Scopus documents by Scopus ID, DOI, PII, or PubMed ID. Supply one identifier type with comma-separated values for multiple documents in one request.
Instructions
Retrieve yearly citation counts and summaries for Scopus documents. Supply one native document identifier type, with comma-separated values for multiple documents. Returns the original Elsevier JSON in one request. Citation Overview access must be enabled for your API key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doi | No | One or more comma-separated DOIs. Supply exactly one document identifier type. | |
| pii | No | One or more comma-separated publication item identifiers. Supply exactly one document identifier type. | |
| ver | No | Requested Elsevier resource version. | |
| date | No | Year or inclusive year range for citation counts, e.g. 2024 or 2020-2024. | |
| sort | No | One sort field: sort-year or rowTotal. Prefix with + for ascending or - for descending; no prefix means ascending. | |
| view | No | Citation Overview supports only the STANDARD view. | |
| count | No | Maximum number of results. Elsevier determines the default and maximum from your API service level. | |
| field | No | Comma-separated native response fields to include. Omit to use the full STANDARD view. | |
| reqId | No | Caller-supplied request identifier for tracing this request with Elsevier support. | |
| start | No | Zero-based result offset; Elsevier defaults to zero when omitted. | |
| citation | No | Exclude self-citations or book citations; Elsevier includes all citations when omitted. | |
| author_id | No | Comma-separated author IDs whose citations should be excluded. Ignored when citation is exclude-books. | |
| pubmed_id | No | One or more comma-separated PubMed IDs. Supply exactly one document identifier type. | |
| scopus_id | No | One or more comma-separated Scopus document IDs. Supply exactly one document identifier type. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| abstract-citations-response | Yes | Native Elsevier Citation Overview response. Counts and years remain strings; requested fields may be omitted or null. |