GET /reports

This resource returns a list of reports supported by the API for a given application.

Request

Query parameters

api_keystring required

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

customer_idstring required

Identifies the customer to provide report data for.

searchstring

Keyword search filtered against report name. Allows for searching for a report by name (DR, DR_D1, DR_D2, PR or PR_P1)

Response

List of reports supported by this service for this application.

Report_Namestring required

The long name of the report

Report_IDstring required

The code, ID or short name of the report that is be used in the request to identify the report.

Releasestring required

The release or version number of the report.

Report_Descriptionstring required

A short sentence describing the report.

Pathstring

The path to use when requesting this report on this service. Optional but recommended for custom reports.

Example response

[
  {
    "Report_Name": "Database Search and Item Usage",
    "Report_ID": "DR_D1",
    "Release": "5",
    "Report_Description": "Total and Monthly Searches and Item Usage for each Web of Science Database",
    "Path": "/reports/dr_d1"
  }
]

Changes

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