---
title: "GET /reports/pr"
method: GET
path: "/reports/pr"
---

# GET /reports/pr

`GET /reports/pr`

## Request

- Base URL: `https://api.clarivate.com/api/counter/r5`
- URL: `https://api.clarivate.com/api/counter/r5/reports/pr`
- Auth: API key in header `X-ApiKey`
- TypeScript: <https://skmtc.dev/clarivate/apis/web-of-science-sushi-counter5-api/docs/reports/pr/get.ts> (a function with typed inputs; its response is checked against the schema)

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 select other configuration options

## Query parameters

- `api_key` string, required
- `customer_id` string, required
- `requestor_id` string, required
- `begin_date` string, required
- `end_date` string, required
- `metric_type` string
- `granularity` string
- `attributes_to_show` string

## Response `200`

Platform Master Report

- COUNTERPlatformReport: Describes the formatting needs for the COUNTER Platform Report - the Report_Header and Report_Items (usage stats).
  - `Report_Header` SUSHIReportHeader, required: Generalized report header that defines the requested report, the requestor, the customer, filters applied, reportAttributes applied and any exceptions.
    - `Created` string, dateTime: Time the report was prepared. Format as defined by date-time - RFC3339
    - `Created_By` string: Name of the organization producing the report.
    - `Customer_ID` string: Identifier of the customer the report represents - identifier used on the request
    - `Report_ID` string, required: The report ID or code or shortname. Typically this will be the same code provided in the Report parameter of the request.
    - `Release` string, required: The release or version of the report.
    - `Report_Name` string, required: The long name of the report.
    - `Institution_Name` string: Name of the customer.
    - `Report_Filters` object[]: A List of report filters used for this report. Typically reflect filters provided on the Request. Filters limit the data to be reported on.
      - `Name` string, required: Name of the report filter.
      - `Value` string, required: Value of the report filter.
    - `Report_Attributes` object[]: Any additional attributes applied to the report. Attributes inform the level of detail in the report.
      - `Name` string, required: Name of the report attribute.
      - `Value` string, required: Value of the report attribute.
    - `Exceptions` SUSHIErrorModel[]: Series of exceptions encounted when preparing the report.
      - `Code` integer, required: Error number. See table of error.
      - `Severity` 'Warning' | 'Error' | 'Fatal' | 'Debug' | 'Info', required: Severity of the error.
      - `Message` string, required: Text describing the error.
      - `Help_URL` string: URL describing error details.
      - `Data` string: Additional data provided by the server to clarify the error.
  - `Report_Items` COUNTERPlatformUsage[], required
    - `Platform` string, required: Name of the platform
    - `Performance` COUNTERItemPerformance[], required: The usage data related to the report item
      - `Period` object, required
        - `Begin_Date` string, required: Beginning date for usage in this 'itemPerformance' instance.
        - `End_Date` string, required: Ending date for usage in this 'itemPerformance' instance.
      - `Instance` object[], required
        - `Metric_Type` 'Searches_Automated' | 'Searches_Federated' | 'Searches_Platform' | 'Searches_Regular' | 'Total_Item_Investigations' | 'Total_Item_Requests' | 'Unique_Item_Investigations' | 'Unique_Item_Requests' | 'Unique_Title_Investigations' | 'Unique_Title_Requests' | 'No_License' | 'Limit_Exceeded', required: Type of activity being counted.
        - `Count` integer, required: Usage count > 0. If count is zero, the Intance element should be excluded.

## Other responses

- `default`: unexpected error

---

[API](https://skmtc.dev/clarivate/apis/web-of-science-sushi-counter5-api.md) - [All operations](https://skmtc.dev/clarivate/apis/web-of-science-sushi-counter5-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clarivate/apis/web-of-science-sushi-counter5-api/revisions/4ac0bcdb36cb?raw)