Monitoring endpoint

The monitoring endpoint shows the status of the APIs and any current performance issues or outages. While the API status page gives an overview of current performance and response times, this endpoint gives more detail about the individual APIs.

Accessing the monitoring endpoint

To access the monitoring endpoint, make a GET request with the URL for the APIs you want to see.

For Discovery APIs only: GET https://api.overdrive.com/v1/service/status
For Discovery and Circulation APIs: GET https://patron.api.overdrive.com/v1/service/status
For the Reporting API only: GET https://reports.api.overdrive.com/v1/service/status

Note: You'll need a valid OAuth token to call the monitoring endpoint. Only a standard client token is required, not a patron token.

In the response, you'll see:

A summary of the performance of all APIs
The name and a description of each API
A message and status for each API. Statuses include UP, DOWN, and WARNING.

Note: The Digital Inventory API and Title Link API aren't listed as separate responses. You can use the Discovery API summary to determine if the Digital Inventory API is functioning normally. For the Title Link API, you can use the status of the Search API.

Example request

GET https://api.overdrive.com/v1/service/status
User-Agent: {Your application}
Authorization: Bearer {OAuth access token}
Host: api.overdrive.com

Example response

200 OK
Date: Tue, 11 Jun 2024 21:15:41 GMT
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000; includeSubDomains
Content-Length: 734
Content-Type: application/json; charset=utf-8

[
    {
        "name": "Discovery API",
        "description": "An aggregate summary of the Discovery API's health according to its connections to underlying services.",
        "message": "The service is operating as expected.",
        "status": "UP"
    },
    {
        "name": "Accounts",
        "description": "Used for library account information",
        "message": "The service is operating as expected.",
        "status": "UP"
    },
    {
        "name": "Metadata",
        "description": "Source of title metadata",
        "message": "The service is operating as expected.",
        "status": "UP"
    },
    {
        "name": "Availability",
        "description": "Source of title availability",
        "message": "The service is operating as expected.",
        "status": "UP"
    },
    {
        "name": "Search",
        "description": "Used for searching collections",
        "message": "The service is operating as expected.",
        "status": "UP"
    }
]

If any of the APIs are experiencing issues, the message at the top of the response will display an error, and the status will show "WARNING." You can also see which individual APIs aren't working as expected (status = DOWN).

Example response

200 OK
Date: Tue, 25 Jun 2024 17:22:20 GMT
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000; includeSubDomains
Content-Length: 734
Content-Type: application/json; charset=utf-8
     
[
    {
        "name": "Discovery API",
        "description": "An aggregate summary of the Discovery API's health according to its connections to underlying services.",
        "message": "One or more underlying services are not reporting \"UP\".  Errors or performance degradation can be expected.",
        "status": "WARNING"
    },
    {
        "name": "Accounts",
        "description": "Used for library account information",
        "message": "The service is operating as expected.",
        "status": "UP"
    },
    {
        "name": "Metadata",
        "description": "Source of title metadata",
        "message": "Unable to connect to title metadata.",
        "status": "DOWN"
    },
    {
        "name": "Availability",
        "description": "Source of title availability",
        "message": " Unable to connect to title availability.",
        "status": "DOWN"
    },
    {
        "name": "Search",
        "description": "Used for searching collections",
        "message": "The service is operating as expected.",
        "status": "UP"
    }
]

Best practice: These statuses are cached for one minute, so don't call this endpoint more than once a minute. If you need to make frequent calls to the endpoint, we recommend calling it once every five minutes.