Learn how the Status API helps you monitor the operational health of Demand API endpoints and automate responses to service degradation.
The Status API provides the current operational status of monitored Demand API endpoint groups and individual endpoints.
- Use the Status API to detect service degradation and automatically adapt your integration.
- For example, you can temporarily disable affected functionality, retry requests with backoff, or fail over to alternative workflows while an incident is in progress.
Unlike relying on failed requests to detect service issues, the Status API lets your application check the operational status of Demand API endpoints before sending requests.
Integrating with the Status API enables you to:
✓ Detect service degradation before it significantly impacts your users.
✓ Reduce the mean time to detect (MTTD) operational incidents.
✓ Automatically enable failover or degraded operating modes.
✓ Avoid unnecessary retries against endpoints experiencing outages.
✓ Monitor the health of related endpoint groups instead of checking individual endpoints when appropriate.
Use the Status dashboard to view the current operational status of monitored Demand API endpoints.
Use the Status API when your integration needs to retrieve status programmatically and respond to service degradation.
The Status API continuously evaluates the health of selected Demand API endpoints.
When you call the Status API, it returns the current operational status for:
- Endpoint groups, such as Reservations or Rates and availability.
- The individual endpoints within each group.
Each status is one of three values:
| Status | Meaning |
|---|---|
| up | The endpoint is operating normally. |
| minor_outage | The endpoint is reachable but experiencing degradation, such as elevated latency or partial errors. |
| major_outage | The endpoint is experiencing a significant outage and requests are likely to fail. |
If an endpoint or group is degraded, the response also includes:
- When the issue began (
since) - A human-readable reason describing the incident.
The Status API reports the health of monitored endpoints grouped by functional area. The dashboard currently monitors the following groups and stable Demand API versions.
Currently only available for accommodations.
| Group | Endpoint | API versions |
|---|---|---|
| Rates and availability | /accommodations/search | 3.1 3.2 3.3 |
| /accommodations/availability | 3.1 3.2 3.3 | |
| /accommodations/bulk-availability | 3.1 | |
| Reservations | /orders/details | 3.1 3.2 3.3 |
| /orders/details/accommodations | 3.1 3.2 3.3 | |
| /orders/preview | 3.1 3.2 3.3 | |
| /orders/modify/preview | 3.2 3.3 | |
| /orders/create | 3.1 3.2 3.3 | |
| /orders/cancel | 3.1 3.2 3.3 | |
| /orders/modify | 3.1 3.2 3.3 |
The status reported for a group reflects the most severe status of any monitored endpoint in that group.
For example, if one endpoint has a major_outage, the group status is also major_outage, even if the remaining endpoints are operational.
The Status API reports the current operational state only. It does not provide historical availability data, incident history or uptime statistics.
To start monitoring the operational status of Demand API endpoints, see:
- The Integration guide for technical details.
- The Status API specifications for schema and examples.