Resource | Method | Description |
---|---|---|
https://api.elsevier.com/analytics/scival/institution/ | GET |
Institution Lookup API:
|
https://api.elsevier.com/analytics/scival/institution/{id} | GET |
Institution Lookup API:
|
https://api.elsevier.com/analytics/scival/institution/count | GET |
Institution Lookup API:
|
https://api.elsevier.com/analytics/scival/institution/countryGroupId/{countryGroupId} | GET |
Institution Lookup API:
|
https://api.elsevier.com/analytics/scival/institution/countryId/{countryId} | GET |
Institution Lookup API:
|
https://api.elsevier.com/analytics/scival/institution/search | GET |
Institution Lookup API:
|
https://api.elsevier.com/analytics/scival/institution/metrics | GET |
Institution Lookup API:
|
Institution Lookup API:
GET | getInstitutions() |
Accept | xsd:string (required) default: application/json options: application/json, application/xml, text/xml |
|
Authorization | xsd:string |
|
X-ELS-APIKey | xsd:string (required) |
|
X-ELS-Authtoken | xsd:string |
|
X-ELS-Insttoken | xsd:string |
|
X-ELS-ReqId | xsd:string |
|
httpAccept | xsd:string options: application/json, application/xml, text/xml |
|
access_token | xsd:string |
|
insttoken | xsd:string |
|
apiKey | xsd:string |
|
reqId | xsd:string |
|
application/json | Institution JSON Response:
|
JSON Example |
application/xml | Institution XML Response:
|
XML Example |
text/xml | Institution XML Response:
|
XML Example |
text/xml | Invalid Request:
|
Invalid Request Example |
text/xml | Authentication Error:
|
Authentication Error Example |
text/xml | Authorization/Entitlements Error:
|
Authorization Error Example |
text/xml | Invalid HTTP Method:
|
Invalid Method Example |
text/xml | Invalid Mime Type:
|
Invalid Mime Type Example |
text/xml | Quota Exceeded:
|
Quota Exceeded Example |
text/xml | Generic Error:
|
Generic Error Example |
Institution Lookup API:
GET | getInstitution() |
id | xsd:long |
|
Accept | xsd:string (required) default: application/json options: application/json, application/xml, text/xml |
|
Authorization | xsd:string |
|
X-ELS-APIKey | xsd:string (required) |
|
X-ELS-Authtoken | xsd:string |
|
X-ELS-Insttoken | xsd:string |
|
X-ELS-ReqId | xsd:string |
|
httpAccept | xsd:string options: application/json, application/xml, text/xml |
|
access_token | xsd:string |
|
insttoken | xsd:string |
|
apiKey | xsd:string |
|
reqId | xsd:string |
|
application/json | Institution JSON Response:
|
JSON Example |
application/xml | Institution XML Response:
|
XML Example |
text/xml | Institution XML Response:
|
XML Example |
text/xml | Invalid Request:
|
Invalid Request Example |
text/xml | Authentication Error:
|
Authentication Error Example |
text/xml | Authorization/Entitlements Error:
|
Authorization Error Example |
text/xml | Invalid HTTP Method:
|
Invalid Method Example |
text/xml | Invalid Mime Type:
|
Invalid Mime Type Example |
text/xml | Quota Exceeded:
|
Quota Exceeded Example |
text/xml | Generic Error:
|
Generic Error Example |
Institution Lookup API:
GET | institutionCount() |
Accept | xsd:string (required) default: application/json options: application/json, application/xml, text/xml |
|
Authorization | xsd:string |
|
X-ELS-APIKey | xsd:string (required) |
|
X-ELS-Authtoken | xsd:string |
|
X-ELS-Insttoken | xsd:string |
|
X-ELS-ReqId | xsd:string |
|
httpAccept | xsd:string options: application/json, application/xml, text/xml |
|
access_token | xsd:string |
|
insttoken | xsd:string |
|
apiKey | xsd:string |
|
reqId | xsd:string |
|
application/json | Institution JSON Response:
|
JSON Example |
application/xml | Institution XML Response:
|
XML Example |
text/xml | Institution XML Response:
|
XML Example |
text/xml | Invalid Request:
|
Invalid Request Example |
text/xml | Authentication Error:
|
Authentication Error Example |
text/xml | Authorization/Entitlements Error:
|
Authorization Error Example |
text/xml | Invalid HTTP Method:
|
Invalid Method Example |
text/xml | Invalid Mime Type:
|
Invalid Mime Type Example |
text/xml | Quota Exceeded:
|
Quota Exceeded Example |
text/xml | Generic Error:
|
Generic Error Example |
Institution Lookup API:
GET | getInstitutionsByCountryGroupId() |
countryGroupId | xsd:long |
|
Accept | xsd:string (required) default: application/json options: application/json, application/xml, text/xml |
|
Authorization | xsd:string |
|
X-ELS-APIKey | xsd:string (required) |
|
X-ELS-Authtoken | xsd:string |
|
X-ELS-Insttoken | xsd:string |
|
X-ELS-ReqId | xsd:string |
|
httpAccept | xsd:string options: application/json, application/xml, text/xml |
|
access_token | xsd:string |
|
insttoken | xsd:string |
|
apiKey | xsd:string |
|
reqId | xsd:string |
|
limit | xs:int default: 100 |
|
offset | xs:int default: 0 |
|
application/json | Institution JSON Response:
|
JSON Example |
application/xml | Institution XML Response:
|
XML Example |
text/xml | Institution XML Response:
|
XML Example |
text/xml | Invalid Request:
|
Invalid Request Example |
text/xml | Authentication Error:
|
Authentication Error Example |
text/xml | Authorization/Entitlements Error:
|
Authorization Error Example |
text/xml | Invalid HTTP Method:
|
Invalid Method Example |
text/xml | Invalid Mime Type:
|
Invalid Mime Type Example |
text/xml | Quota Exceeded:
|
Quota Exceeded Example |
text/xml | Generic Error:
|
Generic Error Example |
Institution Lookup API:
GET | getInstitutionsByCountryId() |
countryId | xsd:long |
|
Accept | xsd:string (required) default: application/json options: application/json, application/xml, text/xml |
|
Authorization | xsd:string |
|
X-ELS-APIKey | xsd:string (required) |
|
X-ELS-Authtoken | xsd:string |
|
X-ELS-Insttoken | xsd:string |
|
X-ELS-ReqId | xsd:string |
|
httpAccept | xsd:string options: application/json, application/xml, text/xml |
|
access_token | xsd:string |
|
insttoken | xsd:string |
|
apiKey | xsd:string |
|
reqId | xsd:string |
|
limit | xs:int default: 100 |
|
offset | xs:int default: 0 |
|
application/json | Institution JSON Response:
|
JSON Example |
application/xml | Institution XML Response:
|
XML Example |
text/xml | Institution XML Response:
|
XML Example |
text/xml | Invalid Request:
|
Invalid Request Example |
text/xml | Authentication Error:
|
Authentication Error Example |
text/xml | Authorization/Entitlements Error:
|
Authorization Error Example |
text/xml | Invalid HTTP Method:
|
Invalid Method Example |
text/xml | Invalid Mime Type:
|
Invalid Mime Type Example |
text/xml | Quota Exceeded:
|
Quota Exceeded Example |
text/xml | Generic Error:
|
Generic Error Example |
Institution Lookup API:
GET | institutionSearch() |
Accept | xsd:string (required) default: application/json options: application/json, application/xml, text/xml |
|
Authorization | xsd:string |
|
X-ELS-APIKey | xsd:string (required) |
|
X-ELS-Authtoken | xsd:string |
|
X-ELS-Insttoken | xsd:string |
|
X-ELS-ReqId | xsd:string |
|
httpAccept | xsd:string options: application/json, application/xml, text/xml |
|
access_token | xsd:string |
|
insttoken | xsd:string |
|
apiKey | xsd:string |
|
reqId | xsd:string |
|
query | xsd:string (required) |
This represents the boolean search to be executed to retrieve SciVal Institutions. Valid fields are name, country, and code. Valid operators are OR and AND. ex. query=name(harvard university) AND country(united states) |
limit | xs:int default: 100 |
|
offset | xs:int default: 0 |
|
application/json | Institution JSON Response:
|
JSON Example |
application/xml | Institution XML Response:
|
XML Example |
text/xml | Institution XML Response:
|
XML Example |
text/xml | Invalid Request:
|
Invalid Request Example |
text/xml | Authentication Error:
|
Authentication Error Example |
text/xml | Authorization/Entitlements Error:
|
Authorization Error Example |
text/xml | Invalid HTTP Method:
|
Invalid Method Example |
text/xml | Invalid Mime Type:
|
Invalid Mime Type Example |
text/xml | Quota Exceeded:
|
Quota Exceeded Example |
text/xml | Generic Error:
|
Generic Error Example |
Institution Lookup API:
GET | institutionMetrics() |
Accept | xsd:string (required) default: application/json options: application/json, application/xml, text/xml |
|
Authorization | xsd:string |
|
X-ELS-APIKey | xsd:string (required) |
|
X-ELS-Authtoken | xsd:string |
|
X-ELS-Insttoken | xsd:string |
|
X-ELS-ReqId | xsd:string |
|
httpAccept | xsd:string options: application/json, application/xml, text/xml |
|
access_token | xsd:string |
|
insttoken | xsd:string |
|
apiKey | xsd:string |
|
reqId | xsd:string |
|
metricTypes | xs:string (required) options: AcademicCorporateCollaboration, AcademicCorporateCollaborationImpact, Collaboration, CitationCount, CitationsPerPublication, CollaborationImpact, CitedPublications, FieldWeightedCitationImpact, ScholarlyOutput, PublicationsInTopJournalPercentiles, OutputsInTopCitationPercentiles |
This represents the types of metrics desired in the response. More than one can be specified. ex. metrics=Collaboration,CitationCount |
institutionIds | xs:string |
This represents the SciVal Institution IDs for which metrics are desired in the response. More than one can be specified. ex. institutionIds=508175,50807 |
yearRange | xs:string default: 5yrs options: 3yrs, 3yrsAndCurrent, 3yrsAndCurrentAndFuture, 5yrs, 5yrsAndCurrent, 5yrsAndCurrentAndFuture, 10yrs |
The year range for which to calculate the metric values. For instance, if the current year is 2018, 3yrsAndCurrentAndFuture would be 2015-2019. |
subjectAreaFilterURI | xs:string default: |
In order to filter metrics on a specific subject area, specify the URI of the subject area here. |
includeSelfCitations | xs:boolean default: true |
Whether or not to include self-citations in the metric calculations. Note that only certain metrics take this flag into consideration. |
byYear | xs:boolean default: true |
If set to true, metric values will be returned for each year in the range specified. If set to false, the metric values will be calculated for the entire year range. |
includedDocs | xs:string default: AllPublicationTypes options: AllPublicationTypes, ArticlesOnly, ArticlesReviews, ArticlesReviewsConferencePapers, ArticlesReviewsConferencePapersBooksAndBookChapters, ConferencePapersOnly, ArticlesConferencePapers, BooksAndBookChapters |
The document types to include in the metric calculations. Note that only certain metrics take this flag into consideration. |
journalImpactType | xs:string default: CiteScore options: CiteScore, SNIP, SJR |
The journal impact type to return from the metric calculations. This is only valid for the PublicationsInTopJournalPercentiles metric. |
showAsFieldWeighted | xs:boolean default: false |
Whether or not to display the metric calculations as field-weighted. This is only valid for the OutputsInTopCitationPercentiles metric. |
application/json | Institution JSON Response:
|
JSON Example |
application/xml | Institution XML Response:
|
XML Example |
text/xml | Institution XML Response:
|
XML Example |
text/xml | Invalid Request:
|
Invalid Request Example |
text/xml | Authentication Error:
|
Authentication Error Example |
text/xml | Authorization/Entitlements Error:
|
Authorization Error Example |
text/xml | Invalid HTTP Method:
|
Invalid Method Example |
text/xml | Invalid Mime Type:
|
Invalid Mime Type Example |
text/xml | Quota Exceeded:
|
Quota Exceeded Example |
text/xml | Generic Error:
|
Generic Error Example |