CLclarivate

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

Request

Query parameters

api_keystring required

Developer key parameter, which authenticates you to use the service.

customer_idstring required

Identifies the customer to provide usage for.

requestor_idstring required

Identifies the requester (STeAM User Id) that is asking for report data

begin_datestring required

Usage start date in the form of yyyy-mm-dd or yyyy-mm.

end_datestring required

Usage end date in the form of yyyy-mm-dd or yyyy-mm.

metric_typestring

Optional Report Filter. A list of Metric_Types to return. Specify multiple values by delimiting with a | character. Omitting this parameter will return all metric_types with statistics.

granularitystring

Optional Report Attribute. Include this parameter to allow usage to be retrieved with a granularity of 'month' (default if omitted) or 'totals'

attributes_to_showstring

Optional Report Attribute. A list of attributes to include as separate elements in response (usage will be broken out by attribute values). Multiple attribute names are delimited with a | character. Options include Data_Type and Access_Method

Response

Platform Master Report

Example response

{
  "Report_Header": {
    "Created": "2016-09-08T22:47:31Z",
    "Created_By": "Clarivate",
    "Customer_ID": "12345",
    "Report_ID": "TR_J1",
    "Release": "5",
    "Report_Name": "Journal Requests (Excluding \"OA_Gold\")",
    "Institution_Name": "Mt. Laurel University",
    "Report_Filters": [
      {
        "Name": "Begin_Date",
        "Value": "2015-01-01"
      }
    ],
    "Report_Attributes": [
      {
        "Name": "Granularity",
        "Value": "Totals"
      }
    ],
    "Exceptions": [
      {
        "Code": 3040,
        "Severity": "Warning",
        "Message": "Partial Data Returned.",
        "Data": "Usage data has not been processed for all requested months."
      }
    ]
  },
  "Report_Items": [
    {
      "Platform": "Web of Science",
      "Performance": [
        {
          "Period": {
            "Begin_Date": "2015-01-01",
            "End_Date": "2015-01-31"
          },
          "Instance": [
            {
              "Metric_Type": "Total_Item_Requests",
              "Count": 21
            }
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.