Overview
The Error Logs API allows you to programmatically view failed API requests to understand what is causing them to fail.
Inspecting error logs can be useful to determine whether the cause of an API request failure relates to the API request itself or the host website being down or experiencing technical difficulties.
You can use the Error Logs API in combination with the Backyard API Status Page to inspect any open platform issues. You may also use the Account API to view live updates on any open API issues that may be causing requests to fail.
Which requests are shown in the Error Logs API? Real-time requests to the main API that result in an HTTP 500 response code are shown in the Error Logs API.
Requests run via Collections, or requests that result in any other HTTP response code are not. For example, an HTTP 400 that indicates an error in your request parameters, would not be shown in the Error Logs API.
Error Log Retention Error Logs are retained, and available via the Error Logs API and Backyard API dashboard, for 3 days from the time that they last occurred. If the same request is retried and results in another error then the error log entry will increment its' count property to show the number of occurrances of that same error and the 3 day timer will reset.
In addition to programmatic access to error logs via the Error Logs API you can also view error logs visually, in the Backyard API dashboard.
You can also request email updates when new error logs occur via the Backyard API dashboard.
Next Steps List Error Logs