List

6min

List Error Logs
You can List all of the Error Logs currently set up on your account by making making a  HTTP GET request to the  /errorlogs endpoint.
Error Logs API Rate Limit
There is no charge for requests to the Error Logs API however the it is subject to a rate limit of 60 requests per minute. This limit includes requests made when accessing Error Logs via the Backyard API dashboard.
In the event of the rate limit being hit an  HTTP 429  response code will be returned.
﻿
Parameters
The following querystring (HTTP GET) parameters allow you to refine the results returned by the Error Logs List API.
Parameter
Required
Description
api_key
required
The API key for your account.
search_term
optional
Limits the Error Logs returned to just those containing the search_term in their parameters property.
page
optional
Set the page number of Error Logs to return, defaults to page=1 . 10 Error Logs are returned per page.
sort_by
optional
The sort order to apply to the results. Valid values are date (to sort by Error Log date) or count (to sort by Error Log count).
sort_direction
optional
The sort direction to return results. Valid values are descending or ascending (the default). Use in conjunction with the sort_by parameter.
Example
﻿GET  /errorlogs
In the example below we List error logs on your account:
HTTP
Curl
Node.js
Python
PHP
https://api.backyardapi.com/errorlogs?api_key=demo
https://api.backyardapi.com/errorlogs?api_key=demo
﻿
Backyard API responds with the following JSON showing error logs from your account:
JSON
{
  "request_info": {
    "success": true
  },
  "logs": [
    {
      "id": "a566b6c63aa5a6b0a932827d45c4ecf195c491bc",
      "engine_url": "url opened by API",
      "api_url": "API request URL",
      "date": "2020-01-01T00:00:00.000Z",
      "count": 15,
      "parameters": {
        "param_name": "param_value"
      },
      "result": {
        "request_info": {
          "success": false,
          "message": "Unable to fulfil your request at this time, please retry. You have not been charged for this request."
        }
      }
    }
  ],
  "page": 1,
  "page_count_total": 1,
  "results_count": 1,
  "results_count_total": 1
}
{
  "request_info": {
    "success": true
  },
  "logs": [
    {
      "id": "a566b6c63aa5a6b0a932827d45c4ecf195c491bc",
      "engine_url": "url opened by API",
      "api_url": "API request URL",
      "date": "2020-01-01T00:00:00.000Z",
      "count": 15,
      "parameters": {
        "param_name": "param_value"
      },
      "result": {
        "request_info": {
          "success": false,
          "message": "Unable to fulfil your request at this time, please retry. You have not been charged for this request."
        }
      }
    }
  ],
  "page": 1,
  "page_count_total": 1,
  "results_count": 1,
  "results_count_total": 1
}
﻿
﻿
Backyard API returns the following properties in the List Error Logs response:
Property
Type
Description
request_info
object
An object containing the status of your request.
success
boolean
True/false as to whether the request was successful.
logs
array
An array of Error Log objects. The Error Log object has the following properties:
id
string
The unique ID of the Error Log.
﻿
engine_url
string
The URL that Backyard API attempted to open on the host website to service this request. This can be useful to determine whether the host website is down or experiencing issues that would cause the Backyard API request to fail.
﻿
api_url
string
The Backyard API API request that caused the errored response. Note that, for security, your API Key is removed from the URL.
﻿
date
string
An ISO date/time stamp of the date of the most recent time this error was seen.
﻿
count
string
A count of the total number of times this error was seen.
﻿
parameters
string
A link to the website of the place result.
﻿
thumbnail
object
An object containing each of the API request parameters used in the request that generated the error.
﻿
result
object
An object containing the JSON response the API gave in response to the errored request.
page
number
The current page of results.
page_count_total
number
The total number of pages of results that are available.
results_count
number
The number of error log results on this page of results.
results_count_total
number
The total number of error logs on all pages.
﻿
Next Steps
     Account API﻿

Parameter	Required	Description
api_key	required	The API key for your account.
search_term	optional	Limits the Error Logs returned to just those containing the search_term in their parameters property.
page	optional	Set the page number of Error Logs to return, defaults to page=1 . 10 Error Logs are returned per page.
sort_by	optional	The sort order to apply to the results. Valid values are date (to sort by Error Log date) or count (to sort by Error Log count).
sort_direction	optional	The sort direction to return results. Valid values are descending or ascending (the default). Use in conjunction with the sort_by parameter.

Property	Type	Description
request_info	object	An object containing the status of your request. success boolean True/false as to whether the request was successful.
logs	array	An array of Error Log objects. The Error Log object has the following properties: id string The unique ID of the Error Log. engine_url string The URL that Backyard API attempted to open on the host website to service this request. This can be useful to determine whether the host website is down or experiencing issues that would cause the Backyard API request to fail. api_url string The Backyard API API request that caused the errored response. Note that, for security, your API Key is removed from the URL. date string An ISO date/time stamp of the date of the most recent time this error was seen. count string A count of the total number of times this error was seen. parameters string A link to the website of the place result. thumbnail object An object containing each of the API request parameters used in the request that generated the error. result object An object containing the JSON response the API gave in response to the errored request.
page	number	The current page of results.
page_count_total	number	The total number of pages of results that are available.
results_count	number	The number of error log results on this page of results.
results_count_total	number	The total number of error logs on all pages.

Updated 08 Aug 2024

Did this page help you?

Overview

Account API