Using the SciVal APIs for IR/CRIS/VIVO

1 Introduction

One of the most common uses of Scopus data outside of the SciVal user interface is that of institutional repositories and current research information systems. An Institutional Repository (IR) is a system for collecting, preserving, disseminating and promoting the intellectual output of an institution electronically. Roughly 80% of all universities worldwide have some sort of IR. The size and complexity of an IR can vary and is typically dependent on the institution's level of investment. A Current Research Information System (CRIS) is a database or other information system for storing data on current research by organizations and people, usually through some kind of project activity, financed by a funding program. CRIS databases are often connected to Institutional Repositories, whereby the CRIS system handles internal data aggregation and analysis, and the IR promotes externally what the organization is doing in terms of research and teaching. Also part of this landscape is VIVO (http://vivoweb.org/), an open-source tool for the discovery of researchers across institutions that has similar capabilities for showcasing universities, researchers and their output.

The SciVal user interface allows a user to download SciVal metrics from anywhere in the application using the Export function, but this is labor-intensive for repetitive work. The SciVal API can be used to populate your IR/CRIS/VIVO more efficiently with a rich basket of SciVal metrics for your researchers and Institutions, as it enables developers working on IRs/CRISs/VIVO installations to write programs that automatically extract metrics from SciVal periodically, and add that data to their systems.

2 Querying the API

In order to work with the metric APIs, you will need an APIKey:


The following is a good strategy that can be used to discover researchers and institutions, retrieve their SciVal metrics and how your system can stay up-to-date with the latest metric values.

2.1 Repository population with metrics for researchers

There are two ways to find author ID of any researcher you want to analyse:

You can take multiple Author IDs and use them in one single request using a comma (%2C) to easily retrieve SciVal metrics for all of them:
    https://api.elsevier.com/metrics/metrics?metrics=ScholarlyOutput%2CCitedPublications&authors=6701858763%2C20433296900&yearRange=5yrs&includeSelfCitations=true&byYear=true&includedDocs=AllPublicationTypes&journalImpactType=CiteScore&showAsFieldWeighted=false&indexType=hIndex
    

2.2 Repository population with metrics for institutions

The best way to find out the ID of Institutions you want to analyse, is by using the SciVal Institution API. You can search by institution name, country or (ISO) country code. You can use OR and AND Booleans in the search query:

        https://api.elsevier.com/metrics/institution/search?query=name(Harvard)%20or%20name(Massachusetts%20Institute%20of%20Technology)
    

The response contains all the Institution IDs that match your search:

You can then use the Institution IDs to retrieve metrics for these Institutions:
    https://api.elsevier.com/metrics?metrics=ScholarlyOutput%2CCitedPublications&institutions=508111%2C508076&yearRange=5yrs&includeSelfCitations=true&byYear=true&includedDocs=AllPublicationTypes&journalImpactType=CiteScore&showAsFieldWeighted=false&indexType=hIndex
    

2.3 Stay up-to-date with the latest metric values

After the initial setup, it is much easier to for your IR/CRIS/VIVO to stay up to date with latest metric values available in SciVal. You can query the API to return the current metrics for your institution and researchers.