Checking your Search API health in the partner portal is a great way to ensure that your results are being displayed on Skyscanner. Any sign of failure rates above 5% and/or no result rates above 15% should be cause for concern. If your account manager is not already working with you to resolve the issue, you should reach out to them whenever you notice a concerning success rate.
If you visit https://partnerportal.skyscanner.net/api-health/ and click on the "Failure" tab, you can see the API calls that resulted in error responses. If you expand the error type tab, you can see more details about the specific error type. You can follow these steps to see examples of other types of errors.
Similarly, you can see details about the "No Result" instances, where our system has requested fares and yours responded with no availability.
The data shows the API traffic for the last 3 days in your local time. You can choose to view this information for individual markets or an aggregation of all markets by selecting from the dropdown menu at the top left corner.
API Performance Graph
Here we provide a visual way to illustrate the health of the API implementation on a timeline, so that it's easier for you to have an idea of how the integration performed and the intervals of high and low demands.
Total API calls
This shows the total number of requests sent to your API.
The number of requests to your API that got a successful response.
Failures (or errors) happen when we cannot get proper response from your API partially or completely. A healthy API should keep its failure rate under 5%, any more than that should be looked into and resolved in time. A high failure ratio not only suggest the inefficiency of your API resources, but also prevent us from properly carrying out troubleshooting and engineering works. A prolonged high ratio may leads to your results being filtered out from our public results.
To understand the nature of failures, click view examples for more details. Here are a few common types of failures:
TimeOutException / Connection Timeout
This is most common when we couldn’t get a response from your API within a reasonable period of time. To provide the best user experience possible, please return as many quotes as possible within 10 seconds, and preferably not exceeding 30 seconds.
We are unable to retrieve results from your API due to HTTP error messages. This can mostly because of a internal server error (HTTP 500) or a configuration issue of authentication (HTTP 403). Please contact your engineering team and see if any changes had been made recently as they may be the reason of these errors.
Your API cannot be accessed by us. Some of the API calls failed to get a return value, most likely because of the traffic on your website. You may be able to resolve this by configuring or upgrading your servers.
If due to engineering constraints or other reasons this cannot be done, we can also help changing market/routes settings to meet your current server capability. Kindly raise a support request with Skyscanner Partner Success team and we will be happy to help.
Our parser was unable to find the expected key when processing response from your API. Please contact your IT/engineering team and see if any changes had been made recently to the return response.
Our parser was unable to find the expected value when processing response from your API, for example you may have accidentally changed a value from string to array, which leads to the error. Please contact your IT/engineering team and see if any changes had been made recently to the return response.
Your API cannot be accessed by us. This may be because of a misconfiguration of your server network settings, please ensure all Skyscanner public IPs are whitelisted so that we can access your service. For a list of Skyscanner public IPs, kindly raise a support request with Skyscanner Partner Success team and we will be happy to help.
Our parser was unable to extract quotes from the returned API response, this may be due to either seats / price availability or your business constraints. No results is not counted as either failures or successes. The ratio of no results should be kept under 15%. If you have a specific route restriction requirement, kindly raise a support ticket with Skyscanner Partner Success team and we will be happy to help.