How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Clarivate

Web of Science SUSHI COUNTER5 API

Harvest COUNTER-compliant usage statistics from the Web of Science platform over the NISO SUSHI protocol, in accordance with the COUNTER Release 5 Code of Practice. Approval-only, for site usage administrators, using three-factor credentials. Published contract: 8 operation(s).

Documentation Provider Profile APIs.io OpenAPI GitHub

Web of Science SUSHI COUNTER5 API is one of 26 APIs that Clarivate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include COUNTER, Libraries, NISO SUSHI, and Usage Statistics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 8 paths, and defines 12 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://api.clarivate.com/api/counter/r5.

8 operations 8 paths 12 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.clarivate.com/api/counter/r5
Authentication
API Key
Contact
Clarivate Customer Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Web of Science SUSHI COUNTER5 API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-ApiKey (key). By default, every request must be authenticated.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Operations 8
GET
/status
This resource returns the current status of the reporting service supported by this API.
getAPIStatus 3 params → 200default
GET
/members
This resource returns the list of consortium members related to a CustomerID.
getConsortiumMembers 3 params → 200default
GET
/reports
This resource returns a list of reports supported by the API for a given application.
getReports 3 params → 200default
GET
/reports/pr
This resource returns COUNTER 'Platform Usage' [pr]. COUNTER Platform Master Report (PR). A customizable report summarizing activity across Web of Science that allows the user to apply filters and se…
getPRReport 8 params → 200default
GET
/reports/pr_p1
This resource returns COUNTER 'Platform Usage' [prp1]. This is a Standard View of the Package Master Report that presents usage for the overall Platform broken down by MetricType.
getPRP1Report 5 params → 200default
GET
/reports/dr
This resource returns Database Master Report (DR). A customizable report detailing activity by database that allows the user to apply filters and select other configuration options.
getDRReport 8 params → 200default
GET
/reports/dr_d1
This resource returns COUNTER 'Database Search and Item Usage' [DRD1], a Standard View of Database Master Report. Reports on key search and request metrics needed to evaluate a database.
getDRD1Report 5 params → 200default
GET
/reports/dr_d2
This resource returns COUNTER 'Database Access Denied' [DRD2], a Standard View of Database Master Report. Reports on Access Denied activity for databases where users were denied access because simult…
getDRD2Report 5 params → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SUSHI_report_header (10 properties), COUNTER_database_usage (5 properties), SUSHI_service_status (5 properties), SUSHI_report_list (5 properties). Each schema is shown below with its type and property counts.

SUSHI_error_model
object
Generalized format for presenting errors and exceptions.
5 properties 3 required
SUSHI_report_header
object
Generalized report header that defines the requested report, the requestor, the customer, filters applied, reportAttributes applied and any exceptions.
10 properties 3 required
SUSHI_report_list
object
5 properties 4 required
SUSHI_service_status
object
5 properties 1 required
SUSHI_consortium_member_list
object
4 properties 2 required
SUSHI_org_identifiers
object
Identifier for an organization.
2 properties 2 required
COUNTER_platform_report
object
Describes the formatting needs for the COUNTER Platform Report - the ReportHeader and ReportItems (usage stats).
2 properties 2 required
COUNTER_platform_usage
object
Defines the output for the ReportItems being returned in a Platform Report.
2 properties 2 required
COUNTER_database_report
object
Describes the formatting needs for the COUNTER Database Report - the ReportHeader and ReportItems (usage stats).
2 properties 2 required
COUNTER_database_usage
object
Defines the output for the ReportItems being returned in a Database Report.
5 properties 4 required
COUNTER_publisher_identifiers
object
2 properties 2 required
COUNTER_item_performance
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clarivate-sushi-api-openapi.json Raw ↑

Other APIs Clarivate publishes across the network.

Intellectual Property (IP) Data API
AE Profile APIs.io
Converis Web Services (Read API)
AE Profile APIs.io
Derwent Sequence Search API
AE Profile APIs.io
Web of Science Journals API
AE Profile APIs.io
EndNote REST API
AE Profile APIs.io
Converis Legacy API
AE Profile APIs.io
Converis Additional APIs
AE Profile APIs.io
InCites Document Level Metrics API
AE Profile APIs.io
Web of Science API Expanded
AE Profile APIs.io
Converis CUD API
AE Profile APIs.io
C3 AI API
AE Profile APIs.io
Cortellis Drug Discovery Intelligence SUSHI COUNTER5 API
AE Profile APIs.io
#COUNTER#Libraries#NISO SUSHI#Usage Statistics
← Back to W APIs
API Details
ID
clarivate:sushi-api
Base URL
https://api.clarivate.com/api/counter/r5
Docs
https://developer.clarivate.com/apis/sushi-api
Provider
Clarivate
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sushi-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sushi-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Web of Science SUSHI COUNTER5 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.