Skip to main content

Elsevier Developer Portal

Topic Cluster Lookup API

This represents the lookup interfaces associated with SciVal Topic Clusters.

Summary

Resource Method Description
https://api.elsevier.com/analytics/scival/topicCluster/{id} GET
 Topic Cluster Lookup API: This represents a lookup for a SciVal Topic Cluster.
https://api.elsevier.com/analytics/scival/topicCluster/metrics GET
 Topic Cluster Lookup API: This represents a request to get one or more types of metrics for one or more SciVal Topic Clusters.
https://api.elsevier.com/analytics/scival/topicCluster/countryId/{countryId} GET
 Topic Cluster Lookup API: This request returns the Topic Clusters associated with a SciVal Country.
https://api.elsevier.com/analytics/scival/topicCluster/institutionId/{institutionId} GET
 Topic Cluster Lookup API: This request returns the Topic Clusters associated with a SciVal Institution.
https://api.elsevier.com/analytics/scival/topicCluster/scopusSourceId/{sourceId} GET
 Topic Cluster Lookup API: This request returns the Topic Clusters associated with a Scopus source ID.
https://api.elsevier.com/analytics/scival/topicCluster/metrics/countryId/{countryId} GET
 Topic Cluster Lookup API: This represents a request to get one or more types of metrics for one or more SciVal Topic Clusters within a given country.
https://api.elsevier.com/analytics/scival/topicCluster/metrics/institutionId/{institutionId} GET
 Topic Cluster Lookup API: This represents a request to get one or more types of metrics for one or more SciVal Topic Clusters within a given institution.

Resources


https://api.elsevier.com/analytics/scival/topicCluster/{id}

Topic Cluster Lookup API: This represents a lookup for a SciVal Topic Cluster.

Methods
GET getTopicCluster()

request
template params
id xsd:long This represents the ID of the SciVal Topic Cluster that is being looked up.

header params
Accept xsd:string
(required)
default: application/json
options: application/json, application/xml, text/xml		 This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which 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 API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
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. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.

query params
httpAccept xsd:string
options: application/json, application/xml, text/xml		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
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.

responses
status:
200
representations
application/json Topic Cluster JSON Response: This is XML representing the requested document. JSON Example
status:
200
representations
application/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
200
representations
text/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
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). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
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. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/analytics/scival/topicCluster/metrics

Topic Cluster Lookup API: This represents a request to get one or more types of metrics for one or more SciVal Topic Clusters.

Methods
GET topicClusterMetrics()

request
header params
Accept xsd:string
(required)
default: application/json
options: application/json, application/xml, text/xml		 This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which 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 API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
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. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.

query params
httpAccept xsd:string
options: application/json, application/xml, text/xml		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
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.
metricTypes xs:string
(required)
options: AuthorCount, CitationCount, CitingPatentCount, FieldWeightedCitationImpact, InstitutionCount, ScholarlyOutput, PatentCitationCount, PatentCitationsPerPublication, PatentCitedPublicationCount, TopAuthors, TopInstitutions, TopJournals, TopKeywords

This represents the types of metrics desired in the response. More than one can be specified.



ex. metrics=CitationCount,AuthorCount
topicClusterIds xs:string

This represents the SciVal Topic Cluster IDs for which metrics are desired in the response. More than one can be specified.



ex. topicClusterIds=12,15
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: false

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, ArticlesConferencePapers, BooksAndBookChapters

The document types to include in the metric calculations. Note that only certain metrics take this flag into consideration.

responses
status:
200
representations
application/json Topic Cluster JSON Response: This is XML representing the requested document. JSON Example
status:
200
representations
application/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
200
representations
text/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
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). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
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. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/analytics/scival/topicCluster/countryId/{countryId}

Topic Cluster Lookup API: This request returns the Topic Clusters associated with a SciVal Country.

Methods
GET getTopicClustersByCountryId()

request
template params
countryId xsd:long This represents the ID of the SciVal Country for which Topic Clusters are being returned.

header params
Accept xsd:string
(required)
default: application/json
options: application/json, application/xml, text/xml		 This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which 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 API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
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. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.

query params
httpAccept xsd:string
options: application/json, application/xml, text/xml		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
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.
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.
limit xs:int
default: 100		 This value specifies the number of results to return. Coupled with offset, it can be utilized to paginate results.
offset xs:int
default: 0		 For paginating results, this is how many pages (of size = limit) to skip before returning results.

responses
status:
200
representations
application/json Topic Cluster JSON Response: This is XML representing the requested document. JSON Example
status:
200
representations
application/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
200
representations
text/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
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). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
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. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/analytics/scival/topicCluster/institutionId/{institutionId}

Topic Cluster Lookup API: This request returns the Topic Clusters associated with a SciVal Institution.

Methods
GET getTopicClustersByInstitutionId()

request
template params
institutionId xsd:long This represents the ID of the SciVal Institution for which Topic Clusters are being returned.

header params
Accept xsd:string
(required)
default: application/json
options: application/json, application/xml, text/xml		 This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which 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 API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
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. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.

query params
httpAccept xsd:string
options: application/json, application/xml, text/xml		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
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.
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.
limit xs:int
default: 100		 This value specifies the number of results to return. Coupled with offset, it can be utilized to paginate results.
offset xs:int
default: 0		 For paginating results, this is how many pages (of size = limit) to skip before returning results.

responses
status:
200
representations
application/json Topic Cluster JSON Response: This is XML representing the requested document. JSON Example
status:
200
representations
application/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
200
representations
text/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
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). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
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. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/analytics/scival/topicCluster/scopusSourceId/{sourceId}

Topic Cluster Lookup API: This request returns the Topic Clusters associated with a Scopus source ID.

Methods
GET getTopicClustersBySourceId()

request
template params
sourceId xsd:long This represents the ID of the Scopus source (i.e. Journal) for which Topic Clusters are being returned.

header params
Accept xsd:string
(required)
default: application/json
options: application/json, application/xml, text/xml		 This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which 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 API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
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. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.

query params
httpAccept xsd:string
options: application/json, application/xml, text/xml		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
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.
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.
limit xs:int
default: 100		 This value specifies the number of results to return. Coupled with offset, it can be utilized to paginate results.
offset xs:int
default: 0		 For paginating results, this is how many pages (of size = limit) to skip before returning results.

responses
status:
200
representations
application/json Topic Cluster JSON Response: This is XML representing the requested document. JSON Example
status:
200
representations
application/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
200
representations
text/xml Topic Cluster XML Response: This is XML representing the requested document. XML Example
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
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). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
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. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/analytics/scival/topicCluster/metrics/countryId/{countryId}

Topic Cluster Lookup API: This represents a request to get one or more types of metrics for one or more SciVal Topic Clusters within a given country.

Methods
GET countryTopicClusterMetrics()

request
template params
countryId xs:long
countryId xsd:long This represents the ID of the SciVal Country that the metrics are returned for.

header params
Accept xsd:string
(required)
default: application/json
options: application/json, application/xml, text/xml		 This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which 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 API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
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. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.

query params
httpAccept xsd:string
options: application/json, application/xml, text/xml		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
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.
topicClusterId xs:long This represents the ID of the SciVal Topic Cluster that the metrics are returned for.
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.
metricTypes xs:string
(required)
options: CitationCount, ScholarlyOutput, FieldWeightedCitationImpact, PatentCitationCount, PatentCitationsPerPublication, PatentCitedPublicationCount, PublicationShare, PublicationShareGrowth

This represents the types of metrics desired in the response. More than one can be specified.



ex. metrics=CitationCount,ScholarlyOutput

responses
status:
200
representations
application/json Topic JSON Response: This is XML representing the requested document. JSON Example
status:
200
representations
application/xml Topic XML Response: This is XML representing the requested document. XML Example
status:
200
representations
text/xml Topic XML Response: This is XML representing the requested document. XML Example
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
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). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
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. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/analytics/scival/topicCluster/metrics/institutionId/{institutionId}

Topic Cluster Lookup API: This represents a request to get one or more types of metrics for one or more SciVal Topic Clusters within a given institution.

Methods
GET institutionTopicClusterMetrics()

request
template params
institutionId xs:long
institutionId xsd:long This represents the ID of the SciVal Institution that the metrics are returned for.

header params
Accept xsd:string
(required)
default: application/json
options: application/json, application/xml, text/xml		 This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which 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 API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
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. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.

query params
httpAccept xsd:string
options: application/json, application/xml, text/xml		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
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.
topicClusterId xs:long This represents the ID of the SciVal Topic Cluster that the metrics are returned for.
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.
metricTypes xs:string
(required)
options: CitationCount, ScholarlyOutput, FieldWeightedCitationImpact, PublicationShare, PublicationShareGrowth

This represents the types of metrics desired in the response. More than one can be specified.



ex. metrics=CitationCount,ScholarlyOutput

responses
status:
200
representations
application/json Topic JSON Response: This is XML representing the requested document. JSON Example
status:
200
representations
application/xml Topic XML Response: This is XML representing the requested document. XML Example
status:
200
representations
text/xml Topic XML Response: This is XML representing the requested document. XML Example
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
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). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
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. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example