Skip to main content

New HTTP Status Code for timeout

What is the change?​

To help improve the clarity of intermittent issues in the Public API, the Public API will now differentiate between an Internal Server Error and a Timeout. This will allow for better error handling and retry logic when an endpoint timeout occurs.

Generally, when a timeout happens, one of the two below error codes are returned. The error code will now be returned to the caller with the httpStatus 504 - Gateway Timeout.

{
   "meta": {
       "httpStatus": "500 - Internal Server Error",
       "error": {
           "errorMessage": "Internal server error. Please contact Qualtrics support.",
           "errorCode": "BRE_0.2",
       },
       "requestId": "d8011e82-c014-4d2e-a5d2-bf8fb8806988"
   }
}

OR

{
   "meta": {
       "httpStatus": "500 - Internal Server Error",
       "error": {
           "errorMessage": "Internal server error. Please contact Qualtrics support.",
           "errorCode": "QHRI_4.0",
       },
       "requestId": "d8011e82-c014-4d2e-a5d2-bf8fb8806988"
   }
}

What action do I need to take?​

Please update any API retry logic to correctly handle the new HTTP status code for timeouts.

To ensure the reliability of your workstream, please ensure this new http response code handling is in place by October 19th, 2021.

What if I have questions?​

If you have a question about the new HTTP Status Code for timeouts, please visit the Public API documentation site. It’s also always worth checking the XM Community to see if any other users have the same question. If you’d rather speak to a specialist, our Support Team is always ready to assist. To contact them, please log into your Support Portal.