Error Messages

Error Messages

Last Updated On November 09, 2019

You may encounter the following error messages while using the API Connector add-on for Google Sheets.

ERROR: Please enter request name

All API requests must have a name before they can be run. This is true even if you don’t save the request. Enter a name (as a best practice, choose a name that will easily differentiate the request from other API requests in your sheet).

ERROR: Please enter API URL path

All API requests must contain an API URL. This URL should consist of at least a domain name and endpoint, e.g. www.apisite.com/v1/data. Optionally, it can also contain query strings, e.g. www.apisite.com/v1/data?query=A&query=B.

ERROR: Please enter destination sheet

Before running an API request, set a destination sheet for the output. To set a destination sheet, you can click on a tab in your worksheet and then click Set to choose that sheet as the destination. Alternately, you can type in your tab name directly.

ERROR: Destination tab doesn’t exist

Your output tab must exist before you choose it as a destination. If you enter a tab name that hasn’t been created yet, you’ll receive this error message. To resolve, first create the tab in your spreadsheet, and then Set it as your destination tab.

Failed to save request as the name already exists.

All API requests must have a unique name. If you re-use a name that already exists, the request will not save. To resolve, change the request name and retry.

Request failed: Server response is not valid JSON

This error occurs when you’re requesting a text or XML API endpoint. API Connector currently only supports JSON responses. Most current API platforms provide a JSON option, so look for a JSON endpoint to resolve this error.

Request failed: Invalid POST body data

This error occurs when your POST body is incorrectly formatted. Ensure your POST body is valid JSON. Consult this article for more detailed instructions: Add a Request Body to a POST Request

Request failed: Server responded with an error

This error message occurs when the platform you’re trying to connect to refuses to run your request. Common reasons for this include:

  • the API endpoint only accepts HTTP POST requests but you’re sending a GET request (or vice versa)
  • your request contains misspelled or missing Header keys
  • your POST request contains a malformed or missing POST body
  • you have entered a non-existent or malformed API URL
  • you’ve included an invalid value for a query string (e.g. ‘num=50’, when ‘num’ must be less than 20)

To resolve, please check the documentation of your API service, and ensure your request matches the requirements exactly. Make sure you’ve replaced any example variables with the actual value, e.g. a variable like {your API key} should be replaced by your actual API key.

Request failed: DNS error

This means the server you’re trying to reach doesn’t exist or isn’t responding. Check if your server has reported any outages. If not, double-check your API URL and run again.

Request failed: Bad request

This means the API URL hostname is malformed. A request like http://87000 would trigger this error. Make sure you’ve entered a valid API URL, including a full hostname.

Request failed: Invalid argument

This occurs when your URL contains an invalid character, like a space or bracket. There are 2 common causes of this error:

  1. not replacing example variables with actual values:
    Wrong: https://www.googleapis.com/youtube/v3/search?part=snippet&key={API_key}
    Right: https://www.googleapis.com/youtube/v3/search?part=snippet&key=123456789
  2. not encoding special characters. Generally, URLs can only contain the characters A to Z (upper or lower case), numbers, and /.=?-+%&* (the : in “https:” is OK as well). Other characters should be be URL encoded. Google Sheets provides a built-in function ENCODEURL() for encoding URLs (info).
    Wrong: https://site.chargebee.com/api/v2/subscriptions?offset=[“1558137600000″,”14780876”]
    Right: https://site.chargebee.com/api/v2/subscriptions?offset=%5B%221558137600000%22%2C%2214780876%22%5D

Request processed, no records found

This is a notification rather than an error message. It means that there is no issue with the setup of your API request, but the API service returned an empty response.

ScriptError: Authorization is required to perform that action

This is an error from Chrome that sometimes occurs when you have multiple Google accounts open in the same session. To resolve, sign out of your other accounts, or re-open the add-on in a new incognito window.

Service invoked too many times for one day: urlfetch

This error message comes from Google itself. Google has quotas on its usage, as described here: https://developers.google.com/apps-script/guides/services/quotas. A URL Fetch call is a request to get a URL, so one API request is one URL fetch call, and URL Fetch calls are limited to 20,000/day for consumer accounts.

Please note that Google applies this limit to each individual account (each email address), and sums together all the fetch calls from all the sheets you’re using. This includes all scripts, functions, and other add-ons that you may be running in addition to API Connector. Unfortunately Google doesn’t provide any breakdown of where URL fetch calls come from, or any indicator of how close you are to the limit, so you will need to review your sheets manually for excess URL fetch calls. Pay attention to any time-based triggers in your scripts, as well as functions like =importJSON() and =GoogleFinance(), as these may produce URL fetch calls every minute.

Other:

In some cases, API platforms will accept a request but return an error message, for example if your URL is correct but missing credentials. In those cases, their error message will be displayed in the output sheet.

Comments:0

Leave a Reply

Your email address will not be published.