Create API Request Based on a Cell
When using the API Connector add-on for Google Sheets, API requests can be based on dynamic or fixed values within your spreadsheet. This is a very flexible function that enables you to, for example, use an automatically updated date in a spreadsheet as the start or end date of a query.
You may reference cells in the API URL path, Headers, POST body, and JMESPath fields.
Contents
- Reference cell containing full value
- Combine fixed values and cell references
- Reference a list of cells
- Example: dynamic dates
- Notes
Reference cell containing full value
To use this function, wrap your cell reference in 3 plus signs on either side. (The plus signs tell API Connector that this is a cell reference and not part of the original URL.) So a reference to cell B2 in a tab called QuerySheet would be written like this: +++QuerySheet!B2+++
Combine fixed values and cell references
Your request field can contain a combination of fixed values and cell references. Just wrap the cell reference piece in 3 plus signs as described above, like this:
Reference a list of cells
You can both reference cells and stack multiple requests together (paid feature). This is useful for running through a list of requests, like this:
https://itunes.apple.com/search?term=+++Input!A1:A10+++ Example: dynamic dates
Instead of hard coding dates into your requests, you’ll often find it easier to reference a Sheets cell containing a dynamic date. That way you don’t need to manually update your API URL.
Let’s take the Harvest API as an example. Every API will be a bit different, but this will demonstrate the process:
- Check the documentation to see what date fields are available for your API. In this case, Harvest’s documentation shows a few different date fields you can work with:
- Create an Inputs tab in your sheet containing your date, making sure you match any format requirements shown in the documentation. Since this API requires ISO 8601 format, which is like ‘2020-08-28’, set the format with a function like
=text(today()-1,"yyyy-mm-dd"). Your request may not work if you don’t set your format explicitly (setting the format via the display toolbar doesn’t change the underlying format).
- In the API Connector sidebar, construct your API request URL to include your date fields from the Inputs sheet, e.g.
https://api.harvestapp.com/v2/time_entries?from=+++Inputs!B2+++&to=+++Inputs!B3+++ - Now every time you run your request, it will use the dynamic date fields from your sheet.
Notes
- The ImportAPI() Custom Sheets Function is an alternate method of running API requests based on a cell.
can post requests be sent?
Not currently, but this feature is coming very soon!
This feature is live now : )
So, linking to cells for a POST is now possible? If so, can the body of a request be dynamic based with fields tied to cells?
Sorry, currently only the API request URL can be based off a cell, not the request body.
Awesome Ana, thanks for making the POST feature possible 🙂 looking forward to link cells in the request body too!!
You can now base the request body on a cell. I’ve updated the documentation above to reflect that.
Hello Ana, firstly I would like to thank you for your contribution, this add-on is simply a great work!
Quick question – would it be possible to Trigger the API call when there is a change in the Cell Value? There are few scenarios where this would be helpful.
Thank you for your kind words, I appreciate that. Triggering API calls on cell changes is an interesting idea, I just emailed you to ask for more detail on what you’re looking for.
I’ve now added a feature to trigger API calls based on cell changes. Please see this article for more info: https://mixedanalytics.com/knowledge-base/importapi-custom-sheets-function/
Can you reference a cell in the required headers? APIs often require authentication tokens in the header, which then require an API POST to get that token for their temporary period of time (usually 5min). Great add-on by the way, makes writing APIs super easy!
Disregard, I saw you already added this! Thanks!
Hello, I am new to API calls. If I wanted to use parameters how would I adjust for that in the API add-on. Example, I want to do an API call to get the value of a vehicle. Here is an example from the API source: GET
http://api.carsxe.com/marketvalue?key=&vin=1FT8X3BT0BEA61538&mileage=120000&interval=180&format=jsonAre the variables HEADERS? Can you assist me?
You would add that entire URL into the API URL Path input field, making sure to include your API key in the empty space where it reads
?key=(the API documentation should tell you how to get your API key). The documentation will also tell you if that API requires headers; if not, you’d just leave that section blank. I suggest checking out the Quick Start article for a complete example of how to set up and run an API request.Is there a way to stack calls similar to how we use a range of cells such as:
http://dnd5eapi.co/api/equipment/+++EquipmentList!B3+++/
http://dnd5eapi.co/api/equipment/+++EquipmentList!B4+++/
http://dnd5eapi.co/api/equipment/+++EquipmentList!B5+++/
but instead do this:
http://dnd5eapi.co/api/equipment/+++EquipmentList!B3:B5+++/
No, but that’s actually a very good idea! Thank you for suggesting. I’ll add that to the to-do list for a future release.
Thank you for the quick reply!
This has now been implemented : ) Please check this article for more information.
This is a great tool. Is there a way to stack cells in body as well? I tried with +++Sheet1!A2:A5+++ but returns only A2.
Currently you can only stack URLs, not POST bodies. Sorry for the inconvenience but I hope that helps clarify. I’ll consider adding that feature in the future.
You can now stack POST bodies too, you can see more about that in this article (check the section called “Multiple POST Bodies”).
doesnt it work on jmespath??
The JMESPath field does not currently accept cell references, cell references can only be used in the request URL, headers, and POST body fields. Sorry for the inconvenience, I’ll try to add that in the future.
thank you. please add that.
Added! You can now reference cells in your JMESPath expression too.
Is it possible to output the result to a specific cell?
If you run requests through the sidebar, they will always output to cell A1 (or the first empty cell in append mode). So I think you have two options:
1) pull data into a ‘raw data’ sheet, and then use VLOOKUP or QUERY functions to pull the data exactly where you want it in a second sheet.
2) use API Connector’s custom IMPORTAPI function, which lets you pull data to any cell you want. It has some caveats, though (you can read about those in the linked article)