{ "swagger": "2.0", "info": { "title": "", "version": "3.0.1" }, "host": "api.elsevier.com", "basePath": "/analytics/scival", "schemes": [ "https" ], "paths": { "/author/institutionId/{institutionId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "SciVal institution id of requested authors", "format": "int64", "in": "path", "name": "institutionId", "required": true, "type": "integer", "x-example": 508175 }, { "default": "5yrs", "description": "Year range of returned authors", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": 100, "description": "The number of authors to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of authors to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/AuthorsResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Author Lookup API" ], "description": "a maximum of 500 authors are available per institution, sorted by the author's scholarly output in descending order", "operationId": "getAuthorsByInstitutionId", "summary": "Get authors by SciVal institution id" } }, "/author/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "Collaboration", "CitationCount", "CitationsPerPublication", "CitingPatentCount", "CollaborationImpact", "CitedPublications", "FieldWeightedCitationImpact", "HIndices", "ScholarlyOutput", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationsInTopJournalPercentiles", "OutputsInTopCitationPercentiles", "ViewsPerPublication" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "description": "Author ids to return metrics for", "in": "query", "name": "authors", "required": true, "type": "string", "x-example": "6701858763,20433296900" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "", "description": "The URI of the subject area by which to filter the returned metrics", "in": "query", "name": "subjectAreaFilterURI", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": true, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "CiteScore", "description": "Desired journal impact type (not applicable to all metrics)", "enum": [ "CiteScore", "SNIP", "SJR" ], "in": "query", "name": "journalImpactType", "type": "string" }, { "default": false, "description": "Whether to show results as field-weighted (not applicable to all metrics)", "in": "query", "name": "showAsFieldWeighted", "type": "boolean" }, { "default": "hIndex", "description": "Desired citation impact type (not applicable to all metrics)", "enum": [ "hIndex", "h5Index", "gIndex", "mIndex" ], "in": "query", "name": "indexType", "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Author Lookup API" ], "operationId": "authorMetrics", "summary": "Get author metrics by id(s)" } }, "/author/orcid/{orcid}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "ORCiD of requested author", "in": "path", "name": "orcid", "required": true, "type": "string", "x-example": "0000-0001-6031-4923" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/AuthorResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Author not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Author Lookup API" ], "operationId": "getAuthorByORCID", "summary": "Get an author by ORCiD" } }, "/author/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Id of requested author", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 6701858763 }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/AuthorResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Author not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Author Lookup API" ], "operationId": "getAuthor", "summary": "Get an author by id" } }, "/country/code/{code}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Code of requested country", "in": "path", "name": "code", "required": true, "type": "string", "x-example": "AUS" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/CountryResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Country not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Country Lookup API V1" ], "operationId": "getCountryByCode", "summary": "Get a country by code" } }, "/country/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "Collaboration", "CitationCount", "CitationsPerPublication", "CitingPatentCount", "CollaborationImpact", "CitedPublications", "FieldWeightedCitationImpact", "HIndices", "ScholarlyOutput", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationsInTopJournalPercentiles", "OutputsInTopCitationPercentiles" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "description": "Country ids to return metrics for", "in": "query", "name": "countryIds", "required": true, "type": "string", "x-example": "36,42" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "", "description": "The URI of the subject area by which to filter the returned metrics", "in": "query", "name": "subjectAreaFilterURI", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": true, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "CiteScore", "description": "Desired journal impact type (not applicable to all metrics)", "enum": [ "CiteScore", "SNIP", "SJR" ], "in": "query", "name": "journalImpactType", "type": "string" }, { "default": false, "description": "Whether to show results as field-weighted (not applicable to all metrics)", "in": "query", "name": "showAsFieldWeighted", "type": "boolean" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Country Lookup API V1" ], "operationId": "countryMetrics", "summary": "Get country metrics by id(s)" } }, "/country/search": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Search query string. Valid fields are name, region, and code. Valid operators are OR and AND.", "in": "query", "name": "query", "required": true, "type": "string", "x-example": "name(brazil)" }, { "default": 100, "description": "The number of results to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of results to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/CountrySearchResponse" } }, "400": { "description": "Query not specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Country Lookup API V1" ], "description": "sorted alphabetically by name in ascending order", "operationId": "countrySearch", "summary": "Find countries by name, region, or region code" } }, "/country/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Id of requested country", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 36 }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/CountryResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Country not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Country Lookup API V1" ], "operationId": "getCountry", "summary": "Get a country by id" } }, "/countryGroup/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "Collaboration", "CitationCount", "CitationsPerPublication", "CitingPatentCount", "CollaborationImpact", "CitedPublications", "FieldWeightedCitationImpact", "HIndices", "ScholarlyOutput", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationsInTopJournalPercentiles", "OutputsInTopCitationPercentiles" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "description": "Country group ids to return metrics for", "in": "query", "name": "countryGroupIds", "required": true, "type": "string", "x-example": "2,3" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "", "description": "The URI of the subject area by which to filter the returned metrics", "in": "query", "name": "subjectAreaFilterURI", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": true, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "CiteScore", "description": "Desired journal impact type (not applicable to all metrics)", "enum": [ "CiteScore", "SNIP", "SJR" ], "in": "query", "name": "journalImpactType", "type": "string" }, { "default": false, "description": "Whether to show results as field-weighted (not applicable to all metrics)", "in": "query", "name": "showAsFieldWeighted", "type": "boolean" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Country Group Lookup API V1" ], "operationId": "countryGroupMetricsV1", "summary": "Get country group metrics by id(s)" } }, "/countryGroup/search": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Search query string. Valid fields are name, category, country, countryId, and code. Valid operators are OR and AND.", "in": "query", "name": "query", "required": true, "type": "string", "x-example": "name(europe)" }, { "default": 100, "description": "The number of results to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of results to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/CountryGroupSearchResponse" } }, "400": { "description": "Query not specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Country Group Lookup API V1" ], "description": "sorted alphabetically by name in ascending order", "operationId": "countryGroupSearchV1", "summary": "Find country groups by name, category, or child country" } }, "/countryGroup/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Id of requested country group", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 3 }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/CountryGroupResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Country group not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Country Group Lookup API V1" ], "operationId": "getCountryGroup", "summary": "Get an country group by id" } }, "/institution": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "default": 100, "description": "The number of results to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of results to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/InstitutionsResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "No institutions were found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Lookup API V1" ], "description": "sorted alphabetically by name in ascending order", "operationId": "getInstitutions", "summary": "Get all institutions" } }, "/institution/count": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/InstitutionCountResponse" } }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Lookup API V1" ], "operationId": "institutionCount", "summary": "Get the number of institutions in SciVal" } }, "/institution/countryGroupId/{countryGroupId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "SciVal country group id of requested institutions", "format": "int64", "in": "path", "name": "countryGroupId", "required": true, "type": "integer", "x-example": 3 }, { "default": "5yrs", "description": "Year range of returned institutions", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": 100, "description": "The number of institutions to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of institutions to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/InstitutionsResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Lookup API V1" ], "description": "sorted by the institution's scholarly output in descending order", "operationId": "getInstitutionsByCountryGroupId", "summary": "Get institutions by SciVal country group id" } }, "/institution/countryId/{countryId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "SciVal country id of requested institutions", "format": "int64", "in": "path", "name": "countryId", "required": true, "type": "integer", "x-example": 36 }, { "default": "5yrs", "description": "Year range of returned institutions", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": 100, "description": "The number of institutions to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of institutions to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/InstitutionsResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Lookup API V1" ], "description": "sorted by the institution's scholarly output in descending order", "operationId": "getInstitutionsByCountryId", "summary": "Get institutions by SciVal country id" } }, "/institution/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "Collaboration", "CitationCount", "CitationsPerPublication", "CitingPatentCount", "CollaborationImpact", "CitedPublications", "FieldWeightedCitationImpact", "HIndices", "ScholarlyOutput", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationsInTopJournalPercentiles", "OutputsInTopCitationPercentiles" ], "in": "query", "name": "metricTypes", "required": true, "type": "string", "x-example": "ScholarlyOutput" }, { "description": "Institution ids to return metrics for", "in": "query", "name": "institutionIds", "required": true, "type": "string", "x-example": "508175,508076" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "", "description": "The URI of the subject area by which to filter the returned metrics", "in": "query", "name": "subjectAreaFilterURI", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": true, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "CiteScore", "description": "Desired journal impact type (not applicable to all metrics)", "enum": [ "CiteScore", "SNIP", "SJR" ], "in": "query", "name": "journalImpactType", "type": "string" }, { "default": false, "description": "Whether to show results as field-weighted (not applicable to all metrics)", "in": "query", "name": "showAsFieldWeighted", "type": "boolean" }, { "default": "hIndex", "description": "Desired citation impact type (not applicable to all metrics)", "enum": [ "hIndex", "h5Index", "gIndex", "mIndex" ], "in": "query", "name": "indexType", "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Lookup API V1" ], "operationId": "institutionMetrics", "summary": "Get institution metrics by id(s)" } }, "/institution/search": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Search query string. Valid fields are name, country, and code. Valid operators are OR and AND.", "in": "query", "name": "query", "required": true, "type": "string", "x-example": "name(harvard university)" }, { "default": 100, "description": "The number of results to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of results to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/InstitutionSearchResponse" } }, "400": { "description": "Query not specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Lookup API V1" ], "description": "sorted alphabetically by name in ascending order", "operationId": "institutionSearch", "summary": "Find institutions by name, country, or country code" } }, "/institution/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Id of requested institution", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 508175 }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/InstitutionResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Institution not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Lookup API V1" ], "operationId": "getInstitution", "summary": "Get an institution by id" } }, "/institutionGroup/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "Collaboration", "CitationCount", "CitationsPerPublication", "CitingPatentCount", "CollaborationImpact", "CitedPublications", "FieldWeightedCitationImpact", "HIndices", "ScholarlyOutput", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationsInTopJournalPercentiles", "OutputsInTopCitationPercentiles" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "description": "Institution group ids to return metrics for", "in": "query", "name": "institutionGroupIds", "required": true, "type": "string", "x-example": "35,195" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "", "description": "The URI of the subject area by which to filter the returned metrics", "in": "query", "name": "subjectAreaFilterURI", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": true, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "CiteScore", "description": "Desired journal impact type (not applicable to all metrics)", "enum": [ "CiteScore", "SNIP", "SJR" ], "in": "query", "name": "journalImpactType", "type": "string" }, { "default": false, "description": "Whether to show results as field-weighted (not applicable to all metrics)", "in": "query", "name": "showAsFieldWeighted", "type": "boolean" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Group Lookup API V1" ], "operationId": "institutionGroupMetrics", "summary": "Get institution group metrics by id(s)" } }, "/institutionGroup/search": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Search query string. Valid fields are name, category, institution, and institutionId. Valid operators are OR and AND.", "in": "query", "name": "query", "required": true, "type": "string", "x-example": "name(ohio)" }, { "default": 100, "description": "The number of results to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of results to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/InstitutionGroupSearchResponse" } }, "400": { "description": "Query not specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Group Lookup API V1" ], "description": "sorted alphabetically by name in ascending order", "operationId": "institutionGroupSearch", "summary": "Find institution groups by name, category, or child institution" } }, "/institutionGroup/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Id of requested institution group", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 35 }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/InstitutionGroupResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Institution group not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Institution Group Lookup API V1" ], "operationId": "getInstitutionGroup", "summary": "Get an institution group by id" } }, "/publication/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "AuthorCount", "CitationCount", "CitedPublications", "CitingPatentCount", "Collaboration", "CollaborationImpact", "FieldWeightedCitationImpact", "FieldWeightedViewsImpact", "JournalImpact", "OutputsInTopCitationPercentiles", "PaperPercentile", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationsInTopJournalPercentiles", "ViewsCount" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "description": "Publication ids to return metrics for", "in": "query", "name": "publicationIds", "required": true, "type": "string", "x-example": "85047328215,85052976466" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": true, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "CiteScore", "description": "Desired journal impact type (not applicable to all metrics)", "enum": [ "CiteScore", "SNIP", "SJR" ], "in": "query", "name": "journalImpactType", "type": "string" }, { "default": false, "description": "Whether to show results as field-weighted (not applicable to all metrics)", "in": "query", "name": "showAsFieldWeighted", "type": "boolean" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Publication Lookup API V1" ], "operationId": "publicationMetrics", "summary": "Get Scopus publication metrics by id(s)" } }, "/publication/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml" ], "parameters": [ { "description": "Id of requested publication", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 85036568406 }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/PublicationResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Publication not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Publication Lookup API V1" ], "operationId": "getDocument", "summary": "Get a Scopus publication by id" } }, "/scopusSource/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "CitingPatentCount", "Collaboration", "CitationCount", "CitationsPerPublication", "CollaborationImpact", "CitedPublications", "FieldWeightedCitationImpact", "ScholarlyOutput", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationsInTopJournalPercentiles", "OutputsInTopCitationPercentiles" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "description": "Scopus source ids to return metrics for", "in": "query", "name": "sourceIds", "required": true, "type": "string", "x-example": "28773,19434" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": true, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "CiteScore", "description": "Desired journal impact type (not applicable to all metrics)", "enum": [ "CiteScore", "SNIP", "SJR" ], "in": "query", "name": "journalImpactType", "type": "string" }, { "default": false, "description": "Whether to show results as field-weighted (not applicable to all metrics)", "in": "query", "name": "showAsFieldWeighted", "type": "boolean" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Scopus Source Lookup API" ], "description": "sorted by name in ascending order", "operationId": "sourceMetrics", "summary": "Get Scopus source metrics by id(s)" } }, "/scopusSource/search": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Search query string. Valid fields are name and subjectArea. Valid operators are OR and AND.", "in": "query", "name": "query", "required": true, "type": "string", "x-example": "name(cancer)" }, { "default": 100, "description": "The number of results to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of results to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/SourceSearchResponse" } }, "400": { "description": "Query not specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Scopus Source Lookup API" ], "description": "sorted by name in ascending order", "operationId": "sourceSearch", "summary": "Find Scopus sources by name or subject area" } }, "/scopusSource/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Id of requested Scopus source", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 12685 }, { "description": "Publication ids to return metrics for", "in": "query", "name": "publicationIds", "required": true, "type": "string", "x-example": "85047328215,85052976466" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/SourceResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Scopus source not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Scopus Source Lookup API" ], "operationId": "getSource", "summary": "Get a Scopus source by id" } }, "/subjectArea/classificationType/{classificationType}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "default": "ASJC", "description": "The subject classification type for which to return subject areas", "enum": [ "ASJC", "FOR", "FOS", "KAKEN", "QS", "THE", "SDG", "POL", "NIRF" ], "in": "path", "name": "classificationType", "required": true, "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/SubjectAreasResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "No subject areas were found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Subject Area Lookup API" ], "operationId": "getSubjectAreasByClassification", "summary": "Get subject areas by classification type" } }, "/subjectArea/search": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Search query string. Valid fields are name and classificatoin. Valid operators are OR and AND.", "in": "query", "name": "query", "required": true, "type": "string", "x-example": "name(biology) AND classification(ASJC)" }, { "default": 100, "description": "The number of results to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of results to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/SubjectAreaSearchResponse" } }, "400": { "description": "Query not specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Subject Area Lookup API" ], "operationId": "subjectAreaSearch", "summary": "Find subject areas by name or classification" } }, "/subjectArea/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "default": 13, "description": "Id of requested subject area", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer" }, { "default": "ASJC", "description": "The subject classification type for which to return subject areas", "enum": [ "ASJC", "FOR", "FOS", "KAKEN", "QS", "THE", "SDG", "POL", "NIRF" ], "in": "query", "name": "classificationType", "required": true, "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/SubjectAreaResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "No subject areas were found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Subject Area Lookup API" ], "operationId": "getSubjectArea", "summary": "Get subject area by id" } }, "/topic/countryId/{countryId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "SciVal country id of requested topics", "format": "int64", "in": "path", "name": "countryId", "required": true, "type": "integer", "x-example": 4 }, { "default": "5yrs", "description": "Year range of returned topics", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": 100, "description": "The number of topics to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of topics to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicsResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Lookup API" ], "description": "sorted by the country's scholarly output in descending order", "operationId": "getTopicsByCountryId", "summary": "Get topics by SciVal country id" } }, "/topic/institutionId/{institutionId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "SciVal institution id of requested topics", "format": "int64", "in": "path", "name": "institutionId", "required": true, "type": "integer", "x-example": 508175 }, { "default": "5yrs", "description": "Year range of returned topics", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": false, "description": "Whether to return key contributing topics only", "in": "query", "name": "keyContribOnly", "type": "boolean" }, { "default": 100, "description": "The number of topics to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of topics to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicsResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Lookup API" ], "description": "sorted by the institution's scholarly output in descending order", "operationId": "getTopicsByInstitutionId", "summary": "Get topics by SciVal institution id" } }, "/topic/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AuthorCount", "CitationCount", "CitingPatentCount", "CorePapers", "FieldWeightedCitationImpact", "InstitutionCount", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "ProminencePercentile", "MostRecentlyPublishedPapers", "RelatedTopics", "ScholarlyOutput", "TopAuthors", "TopCitedPublications", "TopInstitutions", "TopJournals", "TopKeywords" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "default": "17340", "description": "Topic ids to return metrics for", "in": "query", "name": "topicIds", "required": true, "type": "string" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "", "description": "The URI of the subject area by which to filter the returned metrics", "in": "query", "name": "subjectAreaFilterURI", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": false, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicMetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Lookup API" ], "operationId": "topicMetrics", "summary": "Get topic metrics by id(s)" } }, "/topic/metrics/countryId/{countryId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "SciVal country id to filter on", "format": "int64", "in": "path", "name": "countryId", "required": true, "type": "integer" }, { "description": "Topic id to return metrics for", "format": "int64", "in": "query", "name": "topicId", "required": true, "type": "integer", "x-example": 1026 }, { "description": "Types of the desired metrics", "enum": [ "CitationCount", "ScholarlyOutput", "FieldWeightedCitationImpact", "PublicationShare", "PublicationShareGrowth" ], "in": "query", "name": "metricTypes", "type": "string" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicMetricResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Country not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Lookup API" ], "operationId": "countryTopicMetrics", "summary": "Get topic metrics by SciVal country id" } }, "/topic/metrics/institutionId/{institutionId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "SciVal institution id to filter on", "format": "int64", "in": "path", "name": "institutionId", "required": true, "type": "integer" }, { "description": "Topic id to return metrics for", "format": "int64", "in": "query", "name": "topicId", "required": true, "type": "integer", "x-example": 1026 }, { "description": "Types of the desired metrics", "enum": [ "CitationCount", "ScholarlyOutput", "FieldWeightedCitationImpact", "PublicationShare", "PublicationShareGrowth" ], "in": "query", "name": "metricTypes", "type": "string" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicMetricResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Institution not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Lookup API" ], "operationId": "institutionTopicMetrics", "summary": "Get topic metrics by SciVal institution id" } }, "/topic/scopusSourceId/{sourceId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Source id of requested topics", "format": "int64", "in": "path", "name": "sourceId", "required": true, "type": "integer", "x-example": 12685 }, { "default": "5yrs", "description": "Year range of returned topics", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": false, "description": "Whether to return key contributing topics only", "in": "query", "name": "keyContribOnly", "type": "boolean" }, { "default": 100, "description": "The number of topics to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of topics to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicsResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Lookup API" ], "description": "sorted by the Scopus source's scholarly output in descending order", "operationId": "getTopicsBySourceId", "summary": "Get topics by Scopus source id" } }, "/topic/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Id of requested topic", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 17340 }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Topic not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Lookup API" ], "operationId": "getTopic", "summary": "Get a topic by id" } }, "/topicCluster/countryId/{countryId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "SciVal country id of requested topic clusters", "format": "int64", "in": "path", "name": "countryId", "required": true, "type": "integer", "x-example": 4 }, { "default": "5yrs", "description": "Year range of returned topic clusters", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": 100, "description": "The number of topic clusters to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of topic clusters to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicClustersResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Cluster Lookup API" ], "description": "sorted by the country's scholarly output in descending order", "operationId": "getTopicClustersByCountryId", "summary": "Get topic clusters by SciVal country id" } }, "/topicCluster/institutionId/{institutionId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "SciVal institution id of requested topic clusters", "format": "int64", "in": "path", "name": "institutionId", "required": true, "type": "integer", "x-example": 508175 }, { "default": "5yrs", "description": "Year range of returned topic clusters", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": 100, "description": "The number of topic clusters to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of topic clusters to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicClustersResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Cluster Lookup API" ], "description": "sorted by the institution's scholarly output in descending order", "operationId": "getTopicClustersByInstitutionId", "summary": "Get topic clusters by SciVal institution id" } }, "/topicCluster/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AuthorCount", "CitationCount", "CitingPatentCount", "FieldWeightedCitationImpact", "InstitutionCount", "ScholarlyOutput", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "TopAuthors", "TopInstitutions", "TopJournals", "TopKeywords" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "description": "Topic cluster ids to return metrics for", "in": "query", "name": "topicClusterIds", "required": true, "type": "string", "x-example": 23 }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "", "description": "The URI of the subject area by which to filter the returned metrics", "in": "query", "name": "subjectAreaFilterURI", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": false, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "400": { "description": "No entities specified" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Cluster Lookup API" ], "operationId": "topicClusterMetrics", "summary": "Get topic cluster metrics by id(s)" } }, "/topicCluster/metrics/countryId/{countryId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "SciVal country id to filter on", "format": "int64", "in": "path", "name": "countryId", "required": true, "type": "integer" }, { "description": "Topic cluster id to return metrics for", "format": "int64", "in": "query", "name": "topicClusterId", "required": true, "type": "integer", "x-example": 23 }, { "description": "Types of the desired metrics", "enum": [ "CitationCount", "ScholarlyOutput", "FieldWeightedCitationImpact", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationShare", "PublicationShareGrowth" ], "in": "query", "name": "metricTypes", "type": "string" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Country not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Cluster Lookup API" ], "operationId": "countryTopicClusterMetrics", "summary": "Get topic cluster metrics by SciVal country id" } }, "/topicCluster/metrics/institutionId/{institutionId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "SciVal institution id to filter on", "format": "int64", "in": "path", "name": "institutionId", "required": true, "type": "integer" }, { "description": "Topic cluster id to return metrics for", "format": "int64", "in": "query", "name": "topicClusterId", "required": true, "type": "integer", "x-example": 23 }, { "description": "Types of the desired metrics", "enum": [ "CitationCount", "ScholarlyOutput", "FieldWeightedCitationImpact", "PublicationShare", "PublicationShareGrowth" ], "in": "query", "name": "metricTypes", "type": "string" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Institution not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Cluster Lookup API" ], "operationId": "institutionTopicClusterMetrics", "summary": "Get topic cluster metrics by SciVal institution id" } }, "/topicCluster/scopusSourceId/{sourceId}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Scopus source id of requested topic clusters", "format": "int64", "in": "path", "name": "sourceId", "required": true, "type": "integer", "x-example": 12685 }, { "default": "5yrs", "description": "Year range of returned topic clusters", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": 100, "description": "The number of topic clusters to return", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "default": 0, "description": "For paginating results, this is how many pages of topic clusters to skip before returning results", "format": "int32", "in": "query", "name": "offset", "type": "integer" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicClustersResponse" } }, "400": { "description": "The offset for this request must be greater than zero" }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Cluster Lookup API" ], "description": "sorted by the source's scholarly output in descending order", "operationId": "getTopicClustersBySourceId", "summary": "Get topic clusters by Scopus source id" } }, "/topicCluster/{id}": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" }, { "description": "Id of requested topic cluster", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer", "x-example": 23 } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/TopicClusterResponse" } }, "401": { "description": "Request not authorized" }, "404": { "description": "Topic cluster not found" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal Topic Cluster Lookup API" ], "operationId": "getTopicCluster", "summary": "Get a topic cluster by id" } }, "/world/metrics": { "get": { "produces": [ "application/json", "application/xml", "text/xml", "application/vnd.scival.v2+json", "application/vnd.scival.v2+xml" ], "parameters": [ { "description": "Types of the desired metrics", "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "Collaboration", "CitationCount", "CitationsPerPublication", "CitingPatentCount", "CollaborationImpact", "CitedPublications", "FieldWeightedCitationImpact", "HIndices", "ScholarlyOutput", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "PublicationsInTopJournalPercentiles", "OutputsInTopCitationPercentiles" ], "in": "query", "name": "metricTypes", "required": true, "type": "string" }, { "default": "5yrs", "description": "Year range of returned metric (see response values for metricStartYear and metricEndYear for actual years)", "enum": [ "3yrs", "3yrsAndCurrent", "3yrsAndCurrentAndFuture", "5yrs", "5yrsAndCurrent", "5yrsAndCurrentAndFuture", "10yrs" ], "in": "query", "name": "yearRange", "type": "string" }, { "default": "", "description": "The URI of the subject area by which to filter the returned metrics", "in": "query", "name": "subjectAreaFilterURI", "type": "string" }, { "default": true, "description": "Whether to include self-cited documents (not applicable to all metrics)", "in": "query", "name": "includeSelfCitations", "type": "boolean" }, { "default": true, "description": "Whether to return results broken down by year (not applicable to all metrics)", "in": "query", "name": "byYear", "type": "boolean" }, { "default": "AllPublicationTypes", "description": "Publication types to include (not applicable to all metrics)", "enum": [ "AllPublicationTypes", "ArticlesOnly", "ArticlesReviews", "ArticlesReviewsConferencePapers", "ArticlesReviewsConferencePapersBooksAndBookChapters", "ArticlesConferencePapers", "BooksAndBookChapters" ], "in": "query", "name": "includedDocs", "type": "string" }, { "default": "CiteScore", "description": "Desired journal impact type (not applicable to all metrics)", "enum": [ "CiteScore", "SNIP", "SJR" ], "in": "query", "name": "journalImpactType", "type": "string" }, { "default": false, "description": "Whether to show results as field-weighted (not applicable to all metrics)", "in": "query", "name": "showAsFieldWeighted", "type": "boolean" }, { "default": "7f59af901d2d86f78a1fd60c1bf9426a", "description": "Your API key", "in": "query", "name": "apiKey", "required": true, "type": "string" }, { "description": "Specification for authorization, institution authtoken", "in": "query", "name": "insttoken", "required": false, "type": "string" }, { "description": "Specification for active session, secured authtoken", "in": "query", "name": "access_token", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricResponse" } }, "401": { "description": "Request not authorized" }, "500": { "description": "Unknown error encountered" } }, "tags": [ "SciVal World Lookup API" ], "operationId": "worldMetrics", "summary": "Get world metrics" } } }, "definitions": { "AcademicCorporateCollaboration": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/CollabViewObject" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/CollabViewObject" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/CollabViewObject" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/CollabViewObject" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "AcademicCorporateCollaborationImpact": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/CollabImpactView" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/CollabImpactView" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/CollabImpactView" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/CollabImpactView" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "AffiliationResult": { "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "AuthorCount": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "values": { "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "AuthorMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "author": { "$ref": "#/definitions/AuthorResult" } }, "type": "object" } ], "type": "object" }, "AuthorResponse": { "properties": { "author": { "$ref": "#/definitions/AuthorResult" }, "link": { "$ref": "#/definitions/ResponseLink" } }, "type": "object" }, "AuthorResult": { "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "AuthorsResponse": { "properties": { "authors": { "items": { "$ref": "#/definitions/AuthorResult" }, "type": "array" }, "link": { "$ref": "#/definitions/ResponseLink" }, "totalCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "AuthorshipBreakdown": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/AuthorshipView" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/AuthorshipView" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/AuthorshipView" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/AuthorshipView" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "AuthorshipView": { "properties": { "authorshipType": { "type": "string" }, "citationCount": { "format": "int32", "type": "integer" }, "fieldWeightedCitationImpact": { "format": "float", "type": "number" }, "publicationShare": { "format": "float", "type": "number" }, "scholarlyOutput": { "format": "int32", "type": "integer" } }, "type": "object" }, "CitationCount": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "values": { "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "CitationsPerPublication": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "CitedPublications": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "percentage": { "format": "float", "type": "number" }, "percentageByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "percentageByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "values": { "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "CitingPatentCount": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "CollabImpactView": { "properties": { "collabType": { "type": "string" }, "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" } }, "type": "object" }, "CollabViewObject": { "properties": { "collabType": { "type": "string" }, "percentage": { "format": "float", "type": "number" }, "percentageByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "percentageByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "value": { "type": "object" }, "valueByMonth": { "additionalProperties": { "type": "object" }, "type": "object" }, "valueByYear": { "additionalProperties": { "type": "object" }, "type": "object" } }, "type": "object" }, "Collaboration": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/CollabViewObject" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/CollabViewObject" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/CollabViewObject" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/CollabViewObject" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "CollaborationImpact": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/CollabImpactView" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/CollabImpactView" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/CollabImpactView" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/CollabImpactView" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "CorePapers": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/Paper" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/Paper" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/Paper" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/Paper" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "Country": { "properties": { "tags": { "items": { "$ref": "#/definitions/EntityTag" }, "type": "array" }, "active": { "type": "boolean" }, "additionalData": { "type": "string" }, "base": { "type": "string" }, "code": { "type": "string" }, "color": { "type": "string" }, "favorite": { "type": "boolean" }, "id": { "format": "int64", "type": "integer" }, "iso2Code": { "type": "string" }, "latitude": { "format": "float", "type": "number" }, "longitude": { "format": "float", "type": "number" }, "name": { "type": "string" }, "region": { "type": "string" }, "regionName": { "type": "string" }, "secondary": { "type": "string" }, "sortName": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "CountryGroupMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "countryGroup": { "$ref": "#/definitions/CountryGroupSearchResult" } }, "type": "object" } ], "type": "object" }, "CountryGroupResponse": { "properties": { "countryGroup": { "$ref": "#/definitions/CountryGroupResult" }, "link": { "$ref": "#/definitions/ResponseLink" } }, "type": "object" }, "CountryGroupResult": { "allOf": [ { "$ref": "#/definitions/CountryGroupSearchResult" }, { "properties": { "countries": { "items": { "$ref": "#/definitions/CountryResult" }, "type": "array" } }, "type": "object" } ], "type": "object" }, "CountryGroupSearchResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "results": { "items": { "$ref": "#/definitions/CountryGroupSearchResult" }, "type": "array" } }, "type": "object" }, "CountryGroupSearchResult": { "properties": { "categoryName": { "type": "string" }, "countries": { "items": { "$ref": "#/definitions/Country" }, "type": "array" }, "countryCount": { "format": "int32", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "CountryMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "country": { "$ref": "#/definitions/CountrySearchResult" } }, "type": "object" } ], "type": "object" }, "CountryResponse": { "properties": { "country": { "$ref": "#/definitions/CountryResult" }, "link": { "$ref": "#/definitions/ResponseLink" } }, "type": "object" }, "CountryResult": { "properties": { "countryCode": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "regionCode": { "type": "string" }, "regionName": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "CountrySearchResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "results": { "items": { "$ref": "#/definitions/CountrySearchResult" }, "type": "array" } }, "type": "object" }, "CountrySearchResult": { "properties": { "countryCode": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "Discipline": { "properties": { "circleOrder": { "format": "int32", "type": "integer" }, "classificationType": { "type": "string" }, "color": { "type": "string" }, "hasASJCMapping": { "type": "boolean" }, "id": { "format": "int32", "type": "integer" }, "localCode": { "type": "string" }, "localName": { "type": "string" }, "mappingChecked": { "type": "boolean" }, "name": { "type": "string" }, "subjectId": { "format": "int32", "type": "integer" }, "subjectURI": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "EntityInstitutionResult": { "allOf": [ { "$ref": "#/definitions/InstitutionSearchResult" }, { "properties": { "scholarlyOutput": { "format": "int32", "type": "integer" } }, "type": "object" } ], "type": "object" }, "EntityTag": { "properties": { "disabled": { "type": "boolean" }, "id": { "format": "int64", "type": "integer" }, "limitTo": { "type": "boolean" }, "name": { "type": "string" }, "occurrences": { "format": "int32", "type": "integer" }, "privateTag": { "type": "boolean" }, "selected": { "type": "boolean" }, "shared": { "type": "boolean" }, "type": { "type": "string" }, "uri": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" }, "webUserId": { "format": "int64", "type": "integer" } }, "type": "object" }, "EntityTopicClusterResult": { "allOf": [ { "$ref": "#/definitions/TopicClusterSearchResult" }, { "properties": { "overallScholarlyOutput": { "format": "int32", "type": "integer" } }, "type": "object" } ], "type": "object" }, "EntityTopicResult": { "allOf": [ { "$ref": "#/definitions/TopicSearchResult" }, { "properties": { "overallScholarlyOutput": { "format": "int32", "type": "integer" } }, "type": "object" } ], "type": "object" }, "FieldWeightCitationImpact": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "FieldWeightedViewsImpact": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "HIndices": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "indexType": { "type": "string" }, "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "Institution": { "properties": { "tags": { "items": { "$ref": "#/definitions/EntityTag" }, "type": "array" }, "acronym": { "type": "string" }, "active": { "type": "boolean" }, "additionalData": { "type": "string" }, "affilCnt": { "format": "int32", "type": "integer" }, "base": { "type": "string" }, "color": { "type": "string" }, "country": { "$ref": "#/definitions/Country" }, "countryId": { "type": "string" }, "countryName": { "type": "string" }, "favorite": { "type": "boolean" }, "id": { "format": "int64", "type": "integer" }, "latitude": { "format": "double", "type": "number" }, "longitude": { "format": "double", "type": "number" }, "name": { "type": "string" }, "nameVariant1": { "type": "string" }, "nameVariant2": { "type": "string" }, "pubCount": { "format": "int32", "type": "integer" }, "regionName": { "type": "string" }, "secondary": { "type": "string" }, "sector": { "type": "string" }, "sortName": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "InstitutionCount": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "values": { "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "InstitutionCountResponse": { "properties": { "count": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" } }, "type": "object" }, "InstitutionGroupMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "institutionGroup": { "$ref": "#/definitions/InstitutionGroupSearchResult" } }, "type": "object" } ], "type": "object" }, "InstitutionGroupResponse": { "properties": { "institutionGroup": { "$ref": "#/definitions/InstitutionGroupResult" }, "link": { "$ref": "#/definitions/ResponseLink" } }, "type": "object" }, "InstitutionGroupResult": { "allOf": [ { "$ref": "#/definitions/InstitutionGroupSearchResult" }, { "properties": { "institutions": { "items": { "$ref": "#/definitions/InstitutionResult" }, "type": "array" } }, "type": "object" } ], "type": "object" }, "InstitutionGroupSearchResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "results": { "items": { "$ref": "#/definitions/InstitutionGroupSearchResult" }, "type": "array" } }, "type": "object" }, "InstitutionGroupSearchResult": { "properties": { "categoryName": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "institutionCount": { "format": "int32", "type": "integer" }, "institutions": { "items": { "$ref": "#/definitions/Institution" }, "type": "array" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "InstitutionMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "institution": { "$ref": "#/definitions/InstitutionSearchResult" } }, "type": "object" } ], "type": "object" }, "InstitutionResponse": { "properties": { "institution": { "$ref": "#/definitions/InstitutionResult" }, "link": { "$ref": "#/definitions/ResponseLink" } }, "type": "object" }, "InstitutionResult": { "allOf": [ { "$ref": "#/definitions/InstitutionSearchResult" }, { "properties": { "affiliations": { "items": { "$ref": "#/definitions/AffiliationResult" }, "type": "array" }, "latitude": { "format": "double", "type": "number" }, "longitude": { "format": "double", "type": "number" }, "nameVariants": { "items": { "type": "string" }, "type": "array" }, "region": { "type": "string" }, "sector": { "type": "string" } }, "type": "object" } ], "type": "object" }, "InstitutionSearchResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "results": { "items": { "$ref": "#/definitions/InstitutionSearchResult" }, "type": "array" } }, "type": "object" }, "InstitutionSearchResult": { "properties": { "country": { "type": "string" }, "countryCode": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "InstitutionsResponse": { "properties": { "institutions": { "items": { "$ref": "#/definitions/InstitutionSearchResult" }, "type": "array" }, "link": { "$ref": "#/definitions/ResponseLink" }, "totalCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "JournalCategorySearchDoc": { "properties": { "asjcCode": { "items": { "type": "string" }, "type": "array" }, "citeScore": { "type": "string" }, "disciplines": { "items": { "type": "string" }, "type": "array" }, "id": { "format": "int64", "type": "integer" }, "ipp": { "type": "string" }, "isEntity": { "type": "boolean" }, "journalTitle": { "type": "string" }, "mainAsjcCode": { "items": { "type": "string" }, "type": "array" }, "mainSubjects": { "items": { "type": "string" }, "type": "array" }, "sjr": { "type": "string" }, "snip": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "JournalImpact": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "impactType": { "type": "string" }, "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "MetricBase": { "properties": { "lastUpdated": { "type": "string" }, "metricEndYear": { "format": "int32", "type": "integer" }, "metricStartYear": { "format": "int32", "type": "integer" }, "sourceName": { "type": "string" } }, "type": "object" }, "MetricBaseObject": { "discriminator": "metricType", "properties": { "the discriminator field": { "enum": [ "AcademicCorporateCollaboration", "AcademicCorporateCollaborationImpact", "AuthorCount", "AuthorshipBreakdown", "CitationCount", "CitationsPerPublication", "CitedPublications", "CitingPatentCount", "Collaboration", "CollaborationImpact", "CorePapers", "FieldWeightedCitationImpact", "FieldWeightedViewsImpact", "HIndices", "InstitutionCount", "JournalImpact", "MostRecentlyPublishedPapers", "PublicationsInTopJournalPercentiles", "OutputsInTopCitationPercentiles", "PaperPercentile", "PatentCitationCount", "PatentCitationsPerPublication", "PatentCitedPublicationCount", "ProminencePercentile", "PublicationShare", "PublicationShareGrowth", "RelatedTopics", "ScholarlyOutput", "TopAuthors", "TopCitedPublications", "TopInstitutions", "TopJournals", "TopKeywords", "TopTopics", "ViewsCount", "ViewsPerPublication" ], "type": "string" }, "value": { "type": "object" }, "valueByMonth": { "additionalProperties": { "type": "object" }, "type": "object" }, "valueByYear": { "additionalProperties": { "type": "object" }, "type": "object" }, "values": { "items": { "type": "object" }, "type": "array" } }, "required": [ "the discriminator field" ], "type": "object" }, "MetricResponse": { "properties": { "dataSource": { "$ref": "#/definitions/MetricBase" }, "link": { "$ref": "#/definitions/ResponseLink" }, "results": { "items": { "$ref": "#/definitions/MetricResults" }, "type": "array" } }, "type": "object" }, "MetricResults": { "properties": { "metrics": { "items": { "$ref": "#/definitions/MetricBaseObject" }, "type": "array" } }, "type": "object" }, "MostRecentlyPublishedPapers": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/Paper" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/Paper" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/Paper" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/Paper" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "OutputsInTopCitationPercentiles": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/Percentile" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/Percentile" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/Percentile" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/Percentile" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "Paper": { "properties": { "docid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" }, "PaperPercentile": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "values": { "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "PatentCitationCount": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "values": { "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "Percentile": { "properties": { "percentage": { "format": "float", "type": "number" }, "percentageByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "percentageByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "threshold": { "format": "int32", "type": "integer" }, "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" } }, "type": "object" }, "ProminencePercentile": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "PublicationMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "publication": { "$ref": "#/definitions/PublicationSearchResult" } }, "type": "object" } ], "type": "object" }, "PublicationResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "publication": { "$ref": "#/definitions/PublicationResult" } }, "type": "object" }, "PublicationResult": { "allOf": [ { "$ref": "#/definitions/PublicationSearchResult" }, { "properties": { "authors": { "items": { "$ref": "#/definitions/AuthorResult" }, "type": "array" }, "citationCount": { "format": "int32", "type": "integer" }, "institutions": { "items": { "$ref": "#/definitions/InstitutionSearchResult" }, "type": "array" } }, "type": "object" } ], "type": "object" }, "PublicationSearchResult": { "properties": { "authors": { "items": { "$ref": "#/definitions/AuthorResult" }, "type": "array" }, "citationCount": { "format": "int32", "type": "integer" }, "doi": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "institutions": { "items": { "$ref": "#/definitions/InstitutionSearchResult" }, "type": "array" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "publicationYear": { "format": "int32", "type": "integer" }, "sdg": { "items": { "type": "string" }, "type": "array" }, "sourceTitle": { "type": "string" }, "title": { "type": "string" }, "topicClusterId": { "format": "int32", "type": "integer" }, "topicClusterName": { "type": "string" }, "topicId": { "format": "int32", "type": "integer" }, "topicName": { "type": "string" }, "type": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "PublicationSetMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "publicationSet": { "$ref": "#/definitions/PublicationSetSearchResult" } }, "type": "object" } ], "type": "object" }, "PublicationSetResult": { "allOf": [ { "$ref": "#/definitions/PublicationSetSearchResult" }, { "properties": { "docIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "publicationIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } ], "type": "object" }, "PublicationSetSearchResult": { "properties": { "docCount": { "format": "int32", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "publicationCount": { "format": "int32", "type": "integer" }, "uri": { "type": "string" } }, "type": "object" }, "PublicationShare": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "PublicationShareGrowth": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "float", "type": "number" }, "valueByMonth": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "float", "type": "number" }, "type": "object" }, "values": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "PublicationsInTopJournalPercentiles": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "impactType": { "type": "string" }, "value": { "$ref": "#/definitions/Percentile" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/Percentile" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/Percentile" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/Percentile" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "RelatedTopic": { "properties": { "prominencePercentile": { "format": "double", "type": "number" }, "relatedtopicid": { "format": "int64", "type": "integer" }, "relatedtopicrank": { "format": "int32", "type": "integer" }, "relationScore": { "format": "double", "type": "number" }, "relationscore": { "format": "double", "type": "number" }, "topic": { "$ref": "#/definitions/TopicSearchResult" } }, "type": "object" }, "RelatedTopics": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/RelatedTopic" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/RelatedTopic" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/RelatedTopic" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/RelatedTopic" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "ResearcherGroupMetricResult": { "properties": { "available": { "type": "boolean" }, "childCount": { "format": "int32", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "researcherCount": { "format": "int32", "type": "integer" }, "researchers": { "items": { "$ref": "#/definitions/ResearcherMetricResults" }, "type": "array" }, "uri": { "type": "string" } }, "type": "object" }, "ResearcherGroupMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "researcherGroup": { "$ref": "#/definitions/ResearcherGroupMetricResult" } }, "type": "object" } ], "type": "object" }, "ResearcherMetricResults": { "properties": { "metrics": { "items": { "$ref": "#/definitions/MetricBaseObject" }, "type": "array" }, "researcher": { "$ref": "#/definitions/ResearcherSearchResult" } }, "type": "object" }, "ResearcherResult": { "allOf": [ { "$ref": "#/definitions/ResearcherSearchResult" }, { "properties": { "author": { "$ref": "#/definitions/AuthorResult" }, "lastModified": { "type": "string" } }, "type": "object" } ], "type": "object" }, "ResearcherSearchResult": { "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "ResponseLink": { "properties": { "@href": { "type": "string" }, "@ref": { "type": "string" }, "@type": { "type": "string" } }, "type": "object" }, "ScholarlyOutput": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "values": { "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "ScopusSourceResult": { "allOf": [ { "$ref": "#/definitions/SourceSearchResult" }, { "properties": { "subjectAreas": { "items": { "$ref": "#/definitions/SubjectAreaSearchResult" }, "type": "array" } }, "type": "object" } ], "type": "object" }, "SourceResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "source": { "$ref": "#/definitions/SourceSearchResult" } }, "type": "object" }, "SourceSearchResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "results": { "items": { "$ref": "#/definitions/SourceSearchResult" }, "type": "array" } }, "type": "object" }, "SourceSearchResult": { "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "subjectAreas": { "$ref": "#/definitions/JournalCategorySearchDoc" }, "uri": { "type": "string" } }, "type": "object" }, "SubjectAreaResponse": { "properties": { "discipline": { "$ref": "#/definitions/Discipline" }, "link": { "$ref": "#/definitions/ResponseLink" }, "subjectArea": { "$ref": "#/definitions/SubjectAreaResult" } }, "type": "object" }, "SubjectAreaResult": { "properties": { "children": { "items": { "$ref": "#/definitions/SubjectAreaSearchResult" }, "type": "array" }, "classificationName": { "type": "string" }, "classificationType": { "enum": [ "ASJC", "FOR", "FOS", "QS", "KAKEN", "THE", "POL", "SDG", "SCADC", "NIRF" ], "type": "string" }, "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "SubjectAreaSearchResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "results": { "items": { "$ref": "#/definitions/SubjectAreaSearchResult" }, "type": "array" } }, "type": "object" }, "SubjectAreaSearchResult": { "properties": { "children": { "items": { "$ref": "#/definitions/Discipline" }, "type": "array" }, "classificationType": { "enum": [ "ASJC", "FOR", "FOS", "QS", "KAKEN", "THE", "POL", "SDG", "SCADC", "NIRF" ], "type": "string" }, "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "SubjectAreasResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "subjectAreas": { "items": { "$ref": "#/definitions/SubjectAreaSearchResult" }, "type": "array" } }, "type": "object" }, "TopAuthor": { "properties": { "authid": { "format": "int64", "type": "integer" }, "authname": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "numart": { "format": "int32", "type": "integer" }, "publicationCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "TopAuthors": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/TopAuthor" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/TopAuthor" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/TopAuthor" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/TopAuthor" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "TopCitedPublication": { "properties": { "citationCount": { "format": "int32", "type": "integer" }, "docid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "numcites": { "format": "int32", "type": "integer" } }, "type": "object" }, "TopCitedPublications": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/TopCitedPublication" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/TopCitedPublication" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/TopCitedPublication" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/TopCitedPublication" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "TopInstitution": { "properties": { "id": { "format": "int64", "type": "integer" }, "instid": { "format": "int64", "type": "integer" }, "instname": { "type": "string" }, "name": { "type": "string" }, "numart": { "format": "int32", "type": "integer" }, "publicationCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "TopInstitutions": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/TopInstitution" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/TopInstitution" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/TopInstitution" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/TopInstitution" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "TopJournal": { "properties": { "authgrowth": { "format": "float", "type": "number" }, "authorCount": { "format": "int32", "type": "integer" }, "authorGrowth": { "format": "float", "type": "number" }, "citationCount": { "format": "int32", "type": "integer" }, "citeScore": { "format": "float", "type": "number" }, "id": { "format": "int64", "type": "integer" }, "journalid": { "format": "int64", "type": "integer" }, "journalname": { "type": "string" }, "name": { "type": "string" }, "numart": { "format": "int32", "type": "integer" }, "numauth": { "format": "int32", "type": "integer" }, "numcites": { "format": "int32", "type": "integer" }, "pubgrowth": { "format": "float", "type": "number" }, "publicationCount": { "format": "int32", "type": "integer" }, "publicationGrowth": { "format": "float", "type": "number" }, "refp": { "format": "float", "type": "number" }, "sjr": { "format": "float", "type": "number" }, "snip": { "format": "float", "type": "number" } }, "type": "object" }, "TopJournals": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/TopJournal" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/TopJournal" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/TopJournal" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/TopJournal" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "TopKeyword": { "properties": { "keyword": { "type": "string" }, "keyworduri": { "type": "string" }, "name": { "type": "string" }, "numart": { "format": "int32", "type": "integer" }, "pubgrowth": { "format": "float", "type": "number" }, "publicationCount": { "format": "int32", "type": "integer" }, "publicationGrowth": { "format": "float", "type": "number" }, "relevance": { "format": "float", "type": "number" }, "uri": { "type": "string" }, "weight": { "format": "float", "type": "number" } }, "type": "object" }, "TopKeywords": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "$ref": "#/definitions/TopKeyword" }, "valueByMonth": { "additionalProperties": { "$ref": "#/definitions/TopKeyword" }, "type": "object" }, "valueByYear": { "additionalProperties": { "$ref": "#/definitions/TopKeyword" }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/TopKeyword" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "TopicClusterMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "topicCluster": { "$ref": "#/definitions/TopicClusterSearchResult" } }, "type": "object" } ], "type": "object" }, "TopicClusterResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "topicCluster": { "$ref": "#/definitions/TopicClusterResult" } }, "type": "object" }, "TopicClusterResult": { "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "prominencePercentile": { "format": "float", "type": "number" }, "scholarlyOutput": { "format": "int32", "type": "integer" }, "topicCount": { "format": "int32", "type": "integer" }, "topics": { "items": { "$ref": "#/definitions/TopicSearchResult" }, "type": "array" }, "uri": { "type": "string" } }, "type": "object" }, "TopicClusterSearchResult": { "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "prominencePercentile": { "format": "float", "type": "number" }, "scholarlyOutput": { "format": "int32", "type": "integer" }, "topicCount": { "format": "int32", "type": "integer" }, "uri": { "type": "string" } }, "type": "object" }, "TopicClustersResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "topicClusters": { "items": { "$ref": "#/definitions/TopicClusterSearchResult" }, "type": "array" }, "totalCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "TopicMetricResponse": { "allOf": [ { "$ref": "#/definitions/MetricResponse" } ], "type": "object" }, "TopicMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "topic": { "$ref": "#/definitions/TopicSearchResult" } }, "type": "object" } ], "type": "object" }, "TopicResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "topic": { "$ref": "#/definitions/TopicSearchResult" } }, "type": "object" }, "TopicResult": { "allOf": [ { "$ref": "#/definitions/TopicSearchResult" }, { "properties": { "topicCluster": { "$ref": "#/definitions/TopicClusterSearchResult" } }, "type": "object" } ], "type": "object" }, "TopicSearchResult": { "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "prominencePercentile": { "format": "float", "type": "number" }, "scholarlyOutput": { "format": "int32", "type": "integer" }, "uri": { "type": "string" } }, "type": "object" }, "TopicsResponse": { "properties": { "link": { "$ref": "#/definitions/ResponseLink" }, "topics": { "items": { "$ref": "#/definitions/TopicSearchResult" }, "type": "array" }, "totalCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "ViewsCount": { "allOf": [ { "$ref": "#/definitions/MetricBaseObject" }, { "properties": { "value": { "format": "int32", "type": "integer" }, "valueByMonth": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "valueByYear": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "values": { "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object" } ], "required": [ "the discriminator field" ], "type": "object" }, "WorldMetricResults": { "allOf": [ { "$ref": "#/definitions/MetricResults" }, { "properties": { "world": { "$ref": "#/definitions/WorldResult" } }, "type": "object" } ], "type": "object" }, "WorldResult": { "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/ResponseLink" }, "name": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" } }, "tags": [ { "name": "SciVal Author Lookup API" }, { "name": "SciVal Country Group Lookup API" }, { "name": "SciVal Country Lookup API" }, { "name": "SciVal Institution Group Lookup API" }, { "name": "SciVal Institution Lookup API" }, { "name": "SciVal Publication Lookup API" }, { "name": "SciVal Scopus Source Lookup API" }, { "name": "SciVal Subject Area Lookup API" }, { "name": "SciVal Topic Cluster Lookup API" }, { "name": "SciVal Topic Lookup API" }, { "name": "SciVal World Lookup API" } ], "x-components": {} }