Web of Science Expanded API
We are pleased to announce the release of the new Citation Report endpoint for the Expanded API. The Citation Report endpoint allows users to generate a report with valuable bibliometrics for any Web of Science query.
Data available from Citation Report endpoint
– Total times cited
– Times cited without self-citations
– Average citations per item
– Citations per year
– Average number of citations per year
– Number of unique citing articles
– Number of citing articles without self-citations
– H-index
Usage information
To use the Citation Report endpoint, the user first must submit a query to the main search endpoint.
Example initial search request URL: https://wos-api.clarivate.com/api/wos/?databaseId=WOS&usrQuery=TS=cancer and OG=University of Colorado Boulder&count=0&firstRecord=1
Note that it is not required to download any documents, i.e. count=0 is acceptable, as in the example.
The response for the initial query will return a QueryID number. Example response:
Also note the RecordsFound value. Citation Reports can be generated for result sets of up to 10,000 documents. Larger result sets will return an error.
Now, to generate the citation report, the user makes a request to the Citation Report endpoint using the QueryID returned above.
Example citation report request URL: https://wos-api.clarivate.com/api/wos/citation-report/6
Example Citation Report response:
Citation reports can also be generate for individual documents to provide a citation by year for single records.
Example single record request URL: https://wos-api.clarivate.com/api/wos/id/WOS:000270372400005?databaseId=WOS&count=0&firstRecord=1
Response:
Example request to Citation Report endpoint: https://wos-api.clarivate.com/api/wos/citation-report/7
The Citation Report endpoint optionally accepts the following parameters:
– reportLevel: Possible values are WOS and AllDB, which correspond to the Web of Science Core Collection and All Databases, respectively.
– startYear: First year to be returned in CitingYears array. If left blank, it will default to the first year with a citation.
– endYear: Last year to be returned in the CitingYears array. Note that start and endYear parameters do not affect the calculation of the other aggregated metrics, such as the h-value, which will always be calculated based on all citations.
Additionally, the Expanded API now also provides a new field, ‘date_loaded’ in the response, which corresponds to the date searched when a user provides a value for the loadTimeSpan parameter.