CLclarivate

GET /status

This resource returns the current status of the reporting service supported by this API.

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.

requestor_idstring required

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

Response

Status of the reporting service(s) supported by this API.

Descriptionstring

Description of the service.

Service_Activeboolean required

Indicator if the service is currently able to deliver reports.

Registry_URLstring

If available, the URL separate registry with additional information about the service.

Notestring

A general note about the service.

Example response

[
  {
    "Description": "COUNTER Usage Reports for Web of Science platform.",
    "Service_Active": true,
    "Registry_URL": "https://www.projectcounter.org/counter-user/ebsco-database/",
    "Note": "A given customer can request a maximum of 5 requests per day for a given report",
    "Alerts": [
      {
        "Date_Time": "2016-08-02: 12:54",
        "Alert": "Service will be unavailable Sunday midnight..."
      }
    ]
  }
]

Changes

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