{"openapi":"3.1.0","info":{"title":"InCites Document Level Metrics API","description":"The InCites API provides document level metrics from InCites to support integration with Institutional Repository (IR) and Current Research Information Systems (CRIS). Ask your account manager about subscribing to the InCites API, or contact our support team to let us know you are interested.","contact":{"name":"Clarivate Analytics","url":"https://clarivate.com"},"version":"2.0"},"servers":[{"url":"https://incites-api.clarivate.com/api/incites"}],"tags":[{"name":"InCites Metrics API","description":"Provides document-level metrics from InCites for integration with Institutional Repositories (IR)\nand Current Research Information Systems (CRIS).\n\nAppend `/json` or `/xml` to each endpoint path to select the response format.\n"}],"paths":{"/DocumentLevelMetricsByUTforWOS/{format}":{"post":{"tags":["InCites Metrics API"],"summary":"Get document-level metrics by UT for WOS (POST)","description":"POST variant of `DocumentLevelMetricsByUT` for use with Web of Science integrations.\nAccepts a JSON body with a list of UTs — up to 5000 per request.\n\nThis endpoint is useful when submitting more UTs than a query string can handle,\nor when integrating with WOS-based workflows.\n\n**Request body structure:**\n```json\n{\n \"UT\": [\"000352040700014\", \"000614520100001\", \"000353267900023\"],\n \"esci\": \"y\",\n \"schema\": \"wos\"\n}\n```\n\n**Example — JSON:**\n```\nPOST /DocumentLevelMetricsByUTforWOS/json\nContent-Type: application/json\n\n{\"UT\":[\"000352040700014\",\"000614520100001\"],\"esci\":\"y\",\"schema\":\"wos\"}\n```\n\n**Example — XML:**\n```\nPOST /DocumentLevelMetricsByUTforWOS/xml\nContent-Type: application/json\n\n{\"UT\":[\"000352040700014\",\"000614520100001\"],\"esci\":\"y\",\"schema\":\"wos\"}\n```\n","operationId":"getMetricsByUTforWOS","parameters":[{"name":"format","in":"path","description":"Response format: `json` or `xml`","required":true,"schema":{"type":"string"}},{"name":"X-ApiKey","in":"header","description":"Developer key parameter, authenticates you to use the service and ties your institution id to the call.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON payload containing the list of UTs and optional parameters.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `UT` | string[] | Yes | List of 15-character UT accession numbers |\n| `esci` | string | No | Include ESCI content: `y` or `n` |\n| `schema` | string | No | Classification schema (e.g. `wos`, `esi`, `for1`). Defaults to `wos`. |\n\n**Maximum UTs per request:** 5000\n","content":{"application/json":{"schema":{"type":"string"},"examples":{"Basic — 2 UTs":{"description":"Basic — 2 UTs","value":{"UT":["000352040700014","000614520100001"]}},"With ESCI and schema":{"description":"With ESCI and schema","value":{"UT":["000352040700014","000614520100001","000353267900023"],"esci":"y","schema":"wos"}},"With ESI schema":{"description":"With ESI schema","value":{"UT":["000352040700014","000614520100001"],"esci":"y","schema":"esi"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"JSON response":{"description":"JSON response","value":{"api":[{"name":"IncitesWebServices.getDocumentLevelMetricsByUT","rval":[{"ACCESSION_NUMBER":"000352040700014","DOCUMENT_TYPE":"ARTICLE","TIMES_CITED":42,"JOURNAL_EXPECTED_CITATIONS":38.1,"JNCI":1.1,"IMPACT_FACTOR":5.23,"ESI_HIGHLY_CITED_PAPER":0,"ESI_HOT_PAPER":0,"IS_INTERNATIONAL_COLLAB":1,"IS_INSTITUTION_COLLAB":0,"IS_INDUSTRY_COLLAB":0,"RNUM":1}]}]}}}},"application/xml":{"examples":{"XML response":{"description":"XML response","value":"\n \n \n \n
\n \n"}}}}},"400":{"description":"Bad request — validation failure","content":{"application/json":{"examples":{"UT field missing":{"description":"UT field missing","value":{"code":"Bad Request","message":"UT is required."}},"Invalid JSON":{"description":"Invalid JSON","value":{"code":"Bad Request","message":"Json payload not valid."}},"UT limit exceeded (WOS limit 5000)":{"description":"UT limit exceeded (WOS limit 5000)","value":{"code":"Bad Request","message":"UT values exceeded the limit 5000"}}}}}},"500":{"description":"Internal server error","content":{"*/*":{"schema":{"type":"string"}}}},"502":{"description":"MWS returned an empty or unparseable response","content":{"*/*":{"schema":{"type":"string"}}}},"503":{"description":"MWS unreachable or timed out","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/InCitesLastUpdated/{format}":{"get":{"tags":["InCites Metrics API"],"summary":"Get InCites last updated timestamp","description":"Returns the most recent update timestamps for the InCites and Web of Science datasets.\nUse this to determine data freshness before querying metrics.\n\nBacked by the MWS function `IncitesWebServices.getInCitesDates`, whose name is echoed back\nin the `name` field of the response.\n\n**Example — JSON:**\n```\nGET /InCitesLastUpdated/json\n```\n\n**Example — XML:**\n```\nGET /InCitesLastUpdated/xml\n```\n","operationId":"getLastUpdatedInfo","parameters":[{"name":"format","in":"path","description":"Response format: `json` or `xml`","required":true,"schema":{"type":"string"}},{"name":"X-ApiKey","in":"header","description":"Developer key parameter, authenticates you to use the service and ties your institution id to the call.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"JSON response":{"description":"JSON response","value":{"api":[{"name":"IncitesWebServices.getInCitesDates","rval":[{"INCITES_LAST_UPDATED":"2024-09-15","WOS_LAST_UPDATED":"2024-09-14"}]}]}}}},"application/xml":{"examples":{"XML response":{"description":"XML response","value":"\n \n \n \n
\n \n"}}}}},"500":{"description":"Internal server error","content":{"*/*":{"schema":{"type":"string"}}}},"502":{"description":"MWS returned an empty or unparseable response","content":{"*/*":{"schema":{"type":"string"}}}},"503":{"description":"MWS unreachable or timed out","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/DocumentLevelMetricsByUT/{format}":{"get":{"tags":["InCites Metrics API"],"summary":"Get document-level metrics by UT (Unique Tag / accession number)","description":"Returns InCites document-level metrics for up to 100 publication UTs per request.\n\nA **UT (Unique Tag)** is a 15-character alphanumeric accession number used in Web of Science.\nAll trailing zeros must be retained. UTs are comma-delimited.\n\n**Sample UTs you can use for testing:**\n- `000352040700014`\n- `000614520100001`\n- `000353267900023`\n- `000346982900018`\n- `000346342200004`\n\n**Example — JSON:**\n```\nGET /DocumentLevelMetricsByUT/json?UT=000352040700014,000614520100001&esci=y&ver=2&schema=wos\n```\n\n**Example — XML:**\n```\nGET /DocumentLevelMetricsByUT/xml?UT=000352040700014,000614520100001&esci=y&ver=2&schema=wos\n```\n","operationId":"getMetricsByUT","parameters":[{"name":"format","in":"path","description":"Response format: `json` or `xml`","required":true,"schema":{"type":"string"}},{"name":"UT","in":"query","description":"Comma-delimited list of UT accession numbers. A canonical UT is 15 alphanumeric characters\nwith all trailing zeros retained. Values of any shape are accepted and forwarded to InCites,\nwhich decides what exists; unknown UTs simply return no metrics.\nA maximum of 100 UTs may be submitted per request, unless a higher limit is attached to\nyour developer key.\n\nSample UTs: `000352040700014,000614520100001,000353267900023,000346982900018,000346342200004`\n","required":true,"schema":{"type":"string"},"example":"000352040700014,000614520100001"},{"name":"esci","in":"query","description":"Include ESCI content. `y` = include, `n` = exclude.","required":false,"schema":{"type":"string","default":"n","enum":["y","n","Y","N"]},"example":"y"},{"name":"ver","in":"query","description":"API version. Always use `2`.","required":true,"schema":{"type":"string"},"example":2},{"name":"schema","in":"query","description":"Classification schema. See DocumentLevelMetricsByInstitutionId for the full list of valid values. Defaults to `wos`.","required":false,"schema":{"type":"string","default":"wos"},"example":"wos"},{"name":"X-ApiKey","in":"header","description":"Developer key parameter, authenticates you to use the service and ties your institution id to the call.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"JSON response":{"description":"JSON response","value":{"api":[{"name":"IncitesWebServices.getDocumentLevelMetricsByUT","rval":[{"ACCESSION_NUMBER":"000352040700014","DOCUMENT_TYPE":"ARTICLE","TIMES_CITED":42,"JOURNAL_EXPECTED_CITATIONS":38.1,"JNCI":1.1,"IMPACT_FACTOR":5.23,"HARMEAN_CAT_EXP_CITATION":28.5,"AVG_CNCI":1.05,"ESI_HIGHLY_CITED_PAPER":0,"ESI_HOT_PAPER":0,"IS_INTERNATIONAL_COLLAB":1,"IS_INSTITUTION_COLLAB":0,"IS_INDUSTRY_COLLAB":0,"OPEN_ACCESS":"Bronze","RNUM":1,"PERCENTILE":[{"SUBJECT":"Biochemistry & Molecular Biology","CODE":"BC","CATPERCENTILE":67.8,"IS_BEST":1,"CAT_EXP_CITATION":29.1,"CNCI":1.44}]}]}]}}}},"application/xml":{"examples":{"XML response":{"description":"XML response","value":"\n \n \n \n
\n \n"}}}}},"400":{"description":"Bad request — validation failure","content":{"application/json":{"examples":{"Missing UT":{"description":"Missing UT","value":{"code":"Bad Request","message":"UT value cannot be null or empty"}},"UT limit exceeded (default 100)":{"description":"UT limit exceeded (default 100)","value":{"code":"Bad Request","message":"UT values exceeded the limit 100"}}}}}},"500":{"description":"Internal server error","content":{"*/*":{"schema":{"type":"string"}}}},"502":{"description":"MWS returned an empty or unparseable response","content":{"*/*":{"schema":{"type":"string"}}}},"503":{"description":"MWS unreachable or timed out","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/DocumentLevelMetricsByInstitutionIdRecordCount/{format}":{"get":{"tags":["InCites Metrics API"],"summary":"Get total record count by Institution ID and year","description":"Returns the total number of publications linked to your institution for the given year.\nUse this endpoint **before** calling `DocumentLevelMetricsByInstitutionId` to determine\nhow many pages of results exist.\n\nThe institution this call is scoped to is resolved from your `X-ApiKey` — there is no\ninstitution parameter to supply.\n\n**Example:**\n```\nGET /DocumentLevelMetricsByInstitutionIdRecordCount/json?year=2020\n```\n","operationId":"getMetricsCount","parameters":[{"name":"format","in":"path","description":"Response format: `json` or `xml`","required":true,"schema":{"type":"string"}},{"name":"year","in":"query","description":"Publication year. Must be 1980 or later.","required":true,"schema":{"type":"integer","format":"int32"},"example":2020},{"name":"X-ApiKey","in":"header","description":"Developer key parameter, authenticates you to use the service and ties your institution id to the call.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"example":{"api":[{"name":"IncitesWebServices.getNumPublicationsByInstitutionId","rval":[{"RECORD_COUNT":1423}]}]}},"application/xml":{"example":"\n \n \n \n
\n \n"}}},"400":{"description":"Bad request — validation failure","content":{"application/json":{"examples":{"Missing year":{"description":"Missing year","value":{"code":"Bad Request","message":"Year cannot be null or empty and must be after 1980"}},"Non-numeric year":{"description":"Non-numeric year","value":{"code":"Bad Request","message":"year must be a valid number"}},"Year before 1980":{"description":"Year before 1980","value":{"code":"Bad Request","message":"Year cannot be null or empty and must be after 1980"}},"No MyOrg subscription":{"description":"No MyOrg subscription","value":{"code":"Bad Request","message":"InstitutionId value is null because you do not have an active MyOrg subscription which is necessary to use DocumentLevelMetricsByInstitutionIdRecordCount API"}}}}}},"500":{"description":"Internal server error","content":{"*/*":{"schema":{"type":"string"}}}},"502":{"description":"MWS returned an empty or unparseable response","content":{"*/*":{"schema":{"type":"string"}}}},"503":{"description":"MWS unreachable or timed out","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/DocumentLevelMetricsByInstitutionId/{format}":{"get":{"tags":["InCites Metrics API"],"summary":"Get document-level metrics by Institution ID","description":"Returns document-level metrics (citations, NCI, percentile, etc.) for all publications\nlinked to the given institution in a specific year.\n\nUse `DocumentLevelMetricsByInstitutionIdRecordCount` first to determine the total number\nof records, then paginate through with `startingrecord` and `recordcount`.\n\nThe institution this call is scoped to is resolved from your `X-ApiKey` — there is no\ninstitution parameter to supply.\n\n**Example — JSON:**\n```\nGET /DocumentLevelMetricsByInstitutionId/json?year=2020&recordcount=5&startingrecord=1&ver=2&schema=wos&esci=y\n```\n\n**Example — XML:**\n```\nGET /DocumentLevelMetricsByInstitutionId/xml?year=2020&recordcount=5&startingrecord=1&ver=2&schema=wos&esci=y\n```\n","operationId":"getMetrics","parameters":[{"name":"format","in":"path","description":"Response format: `json` or `xml`","required":true,"schema":{"type":"string"}},{"name":"year","in":"query","description":"Publication year to filter results. Must be 1980 or later.","required":true,"schema":{"type":"integer","format":"int32"},"example":2020},{"name":"startingrecord","in":"query","description":"Pagination: index of the first record to return. Starts at 1.","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"recordcount","in":"query","description":"Maximum number of records to return per request. Must be between 1 and 100.","required":true,"schema":{"type":"integer","format":"int32"},"example":5},{"name":"esci","in":"query","description":"Include ESCI (Emerging Sources Citation Index) content. `y` = include, `n` = exclude.","required":false,"schema":{"type":"string","default":"n","enum":["y","n","Y","N"]},"example":"y"},{"name":"ver","in":"query","description":"API version. Always use `2`.","required":true,"schema":{"type":"string"},"example":2},{"name":"schema","in":"query","description":"Classification schema to use for subject categories. Defaults to `wos` (Web of Science categories).\n\n| Value | Description |\n|-------|-------------|\n| `wos` | Web of Science (default) |\n| `capesl1` | CAPES Level 1 |\n| `capesl2` | CAPES Level 2 |\n| `capesl3` | CAPES Level 3 |\n| `for1` | Fields of Research Level 1 |\n| `for2` | Fields of Research Level 2 |\n| `scadcl1` | SCADC Level 1 |\n| `scadcl2` | SCADC Level 2 |\n| `ref2008` | REF 2008 |\n| `ref2014` | REF 2014 |\n| `ref2021` | REF 2021 |\n| `ct` | Citation Topics |\n| `et` | Emerging Topics |\n| `sdg` | Sustainable Development Goals |\n| `gras` | GRAS |\n| `anvur` | ANVUR (Italy) |\n| `esi` | Essential Science Indicators |\n| `fapesp` | FAPESP (Brazil) |\n| `gipp` | GIPP |\n| `kakenl2` | KAKENHI Level 2 |\n| `kakenl3` | KAKENHI Level 3 |\n| `oecd` | OECD |\n| `pl19` | Polish Classification 2019 |\n| `ris3` | RIS3 |\n","required":false,"schema":{"type":"string","default":"wos","enum":["wos","capesl1","capesl2","capesl3","for1","for2","scadcl1","scadcl2","ref2008","ref2014","ref2021","ct","et","sdg","gras","anvur","esi","fapesp","gipp","kakenl2","kakenl3","oecd","pl19","ris3"]},"example":"wos"},{"name":"X-ApiKey","in":"header","description":"Developer key parameter, authenticates you to use the service and ties your institution id to the call.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"JSON response":{"description":"JSON response","value":{"api":[{"name":"IncitesWebServices.getDocumentLevelMetricsByInstitutionId","rval":[{"ACCESSION_NUMBER":"000188396500010","DOCUMENT_TYPE":"ARTICLE","TIMES_CITED":18,"JOURNAL_EXPECTED_CITATIONS":18.89,"JNCI":0.95,"IMPACT_FACTOR":2.055,"PERCENTILE":45.2,"NCI":0.95,"ESI_HIGHLY_CITED_PAPER":0,"ESI_HOT_PAPER":0,"IS_INTERNATIONAL_COLLAB":1,"IS_INSTITUTION_COLLAB":1,"IS_INDUSTRY_COLLAB":0,"RNUM":1}]}]}}}},"application/xml":{"examples":{"XML response":{"description":"XML response","value":"\n \n \n \n
\n \n"}}}}},"400":{"description":"Bad request — validation failure","content":{"application/json":{"examples":{"Missing year":{"description":"Missing year","value":{"code":"Bad Request","message":"Year cannot be null or empty and must be after 1980"}},"Year before 1980":{"description":"Year before 1980","value":{"code":"Bad Request","message":"Year cannot be null or empty and must be after 1980"}},"Record count too high":{"description":"Record count too high","value":{"code":"Bad Request","message":"Record count value cannot be null or empty and must be 1-100"}},"Starting record zero":{"description":"Starting record zero","value":{"code":"Bad Request","message":"Starting record value cannot be null or empty and must be greater than 0"}},"No MyOrg subscription":{"description":"No MyOrg subscription","value":{"code":"Bad Request","message":"InstitutionId value is null because you do not have an active MyOrg subscription which is necessary to use DocumentLevelMetricsByInstitutionId API"}}}}}},"500":{"description":"Internal server error","content":{"*/*":{"schema":{"type":"string"}}}},"502":{"description":"MWS returned an empty or unparseable response","content":{"*/*":{"schema":{"type":"string"}}}},"503":{"description":"MWS unreachable or timed out","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/CheckValidUTs/{format}":{"get":{"tags":["InCites Metrics API"],"summary":"Check UTs and return the ones InCites does not recognise","description":"Submits a comma-delimited list of UTs and returns **only the UTs that are not valid**\n(not found in InCites). An **empty `rval` therefore means every submitted UT is valid** —\nit is a successful result, not an error.\n\nBacked by the MWS function `IncitesWebServices.getInvalidUTsList`, whose name is echoed\nback in the `name` field of the response.\n\nUse this to pre-filter UTs before calling the metrics endpoints. This endpoint returns\nno metrics.\n\n**Example — JSON (one valid UT, one bogus UT):**\n```\nGET /CheckValidUTs/json?UT=000352040700014,ZZZZZZZZZZZZZZZ\n```\n\n**Example — XML:**\n```\nGET /CheckValidUTs/xml?UT=000352040700014,ZZZZZZZZZZZZZZZ\n```\n","operationId":"getValidUTs","parameters":[{"name":"format","in":"path","description":"Response format: `json` or `xml`","required":true,"schema":{"type":"string"}},{"name":"UT","in":"query","description":"Comma-delimited list of UT accession numbers to check. A canonical UT is 15 alphanumeric\ncharacters, but values of any shape are accepted and forwarded to InCites, which decides\nwhat is valid. Up to 100 UTs per request, unless a higher limit is attached to your\ndeveloper key.\n\nSample: `000352040700014,000614520100001,ZZZZZZZZZZZZZZZ`\n","required":true,"schema":{"type":"string"},"example":"000352040700014,000614520100001,ZZZZZZZZZZZZZZZ"},{"name":"X-ApiKey","in":"header","description":"Developer key parameter, authenticates you to use the service and ties your institution id to the call.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success — returns the invalid UTs (empty when all are valid)","content":{"application/json":{"examples":{"Some UTs invalid":{"description":"Some UTs invalid","value":{"api":[{"name":"IncitesWebServices.getInvalidUTsList","rval":["ZZZZZZZZZZZZZZZ"]}]}},"All UTs valid":{"description":"All UTs valid","value":{"api":[{"name":"IncitesWebServices.getInvalidUTsList","rval":[]}]}}}},"application/xml":{"examples":{"XML response":{"description":"XML response","value":"\n \n \n ZZZZZZZZZZZZZZZ\n
\n \n"}}}}},"400":{"description":"Bad request — validation failure","content":{"application/json":{"examples":{"Missing UT":{"description":"Missing UT","value":{"code":"Bad Request","message":"UT value cannot be null or empty"}},"Limit exceeded":{"description":"Limit exceeded","value":{"code":"Bad Request","message":"UT values exceeded the limit 100"}}}}}},"500":{"description":"Internal server error","content":{"*/*":{"schema":{"type":"string"}}}},"502":{"description":"MWS returned an empty or unparseable response","content":{"*/*":{"schema":{"type":"string"}}}},"503":{"description":"MWS unreachable or timed out","content":{"*/*":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"MetricsByUTRequest":{"type":"object","description":"Request body for DocumentLevelMetricsByUTforWOS (POST)","properties":{"UT":{"description":"List of UT accession numbers (15 alphanumeric chars each). Maximum 5000 per request.","example":["000352040700014","000614520100001","000353267900023"],"items":{"type":"string","example":"000352040700014"}},"esci":{"type":"string","description":"Include ESCI content: `y` or `n`","enum":["y","n","Y","N"],"example":"y"},"schema":{"type":"string","description":"Classification schema (e.g. `wos`, `esi`, `for1`). Defaults to `wos`.","example":"wos"}},"required":["UT"]},"ErrorResponse":{"type":"object","description":"Standard error response body returned when a request fails validation or encounters an error","properties":{"code":{"type":"string","description":"HTTP status description or error code","example":"Bad Request"},"message":{"type":"string","description":"Human-readable explanation of what went wrong","example":"UT value cannot be null or empty"}}},"Record":{"type":"object","description":"A single publication record with InCites document-level metrics.\nReturned by DocumentLevelMetricsByUT and DocumentLevelMetricsByInstitutionId.\n","properties":{"ACCESSION_NUMBER":{"type":"string","description":"Web of Science accession number (UT) — 15 alphanumeric characters","example":"000352040700014"},"DOCUMENT_TYPE":{"type":"string","description":"WoS document type","enum":["ARTICLE","REVIEW","PROCEEDINGS PAPER","BOOK CHAPTER","LETTER","EDITORIAL MATERIAL","NOTE"],"example":"ARTICLE"},"TIMES_CITED":{"type":"integer","format":"int32","description":"Total citation count from Web of Science","example":42},"JOURNAL_EXPECTED_CITATIONS":{"type":"number","description":"Expected citations for the journal in this publication year","example":38.1},"JNCI":{"type":"number","description":"Journal Normalized Citation Impact","example":1.1},"IMPACT_FACTOR":{"type":"number","description":"Journal Impact Factor for the publication year","example":5.23},"HARMEAN_CAT_EXP_CITATION":{"type":"number","description":"Harmonic mean of category expected citations","example":28.5},"AVG_CNCI":{"type":"number","description":"Average Category Normalized Citation Impact","example":1.05},"ESI_HIGHLY_CITED_PAPER":{"type":"integer","format":"int32","description":"1 if ESI Highly Cited Paper, 0 otherwise","enum":[0,1],"example":0},"ESI_HOT_PAPER":{"type":"integer","format":"int32","description":"1 if ESI Hot Paper, 0 otherwise","enum":[0,1],"example":0},"IS_INTERNATIONAL_COLLAB":{"type":"integer","format":"int32","description":"1 if the paper has international co-authors, 0 otherwise","enum":[0,1],"example":1},"IS_INSTITUTION_COLLAB":{"type":"integer","format":"int32","description":"1 if the paper has co-authors from other institutions, 0 otherwise","enum":[0,1],"example":0},"IS_INDUSTRY_COLLAB":{"type":"integer","format":"int32","description":"1 if the paper has industry co-authors, 0 otherwise","enum":[0,1],"example":0},"OPEN_ACCESS":{"type":"string","description":"Open access status","enum":["Gold","Green","Bronze","Hybrid",""],"example":"Bronze"},"RNUM":{"type":"integer","format":"int32","description":"Record sequence number (1-based) within the result set","example":1},"PERCENTILE":{"description":"List of category-level percentile data. One entry per subject category.","items":{"$ref":"#/components/schemas/Percentile"}}}},"Percentile":{"type":"object","description":"Subject category percentile data for a publication","properties":{"SUBJECT":{"type":"string","description":"Name of the Web of Science subject category","example":"Biochemistry & Molecular Biology"},"CODE":{"type":"string","description":"Short code for the subject category","example":"BC"},"CATPERCENTILE":{"type":"number","description":"Percentile rank within the subject category (0–100; higher is better)","example":67.8},"IS_BEST":{"type":"integer","format":"int32","description":"1 if this is the best (highest) percentile category for the paper","enum":[0,1],"example":1},"CAT_EXP_CITATION":{"type":"number","description":"Expected citations in this category","example":29.1},"CNCI":{"type":"number","description":"Category Normalized Citation Impact","example":1.44}}},"MetricsByInstitutionIdResponse":{"type":"object","description":"Top-level response envelope returned by all InCites API endpoints","properties":{"api":{"description":"Array containing the function result","items":{"type":"object","properties":{"name":{"type":"string","description":"MWS function name that was invoked","example":"IncitesWebServices.getDocumentLevelMetricsByUT"},"rval":{"description":"Array of result records","items":{"$ref":"#/components/schemas/Record"}}}}}}}},"securitySchemes":{"key":{"type":"apiKey","in":"header","name":"X-ApiKey"}}},"security":[{"key":[]}]}