How to save API requests in Apipheny

Jump to:

The Apipheny add-on for Google Sheets comes with a built-in feature that lets you save your API requests for future use.

This is a very basic feature, but it’s also one of the most important, and we recommend learning it as soon as possible. It’ll save you a ton of time by letting you re-run your saved API requests instead of manually inputting them every time you do your work.

The Save feature is also a prerequisite to using the Schedule feature. If you want to learn how to Save your API requests so you can start Scheduling them, follow the steps below.

Here’s a quick video tutorial to get you started:

How to save your API requests in Apipheny

To save your API request, go to Apipheny’s Import tab, fill out all of the necessary fields (API URL Path, Headers, etc.), then press Save.

If you’re new to Apipheny, just follow the steps below and you’ll be ready to use this feature in no time.

Step 1. Open Google Sheets and run Apipheny.

To begin, go to your spreadsheet then click Add-ons > Apipheny – API Tool > Import API. If you don’t already have the add-on installed, you can install it here.

Apipheny add-on open in Google Sheets

Step 2. Fill out the necessary fields

Input your API URL Path containing the endpoint you want to use, any headers, which sheet you want the request to run on, and customize your API request as necessary.

Step 3. Test your request then save it once you’re satisfied

Once you’re done customizing your request, click Run to test it out then click Save once you’re satisfied to save your request. Apipheny will ask you to name your saved request. Choose an appropriate name that’s easy to remember and click Save to finish the process.

Viewing & running saved requests

To view your saved API requests, go to the Manage tab. There, you’ll see a complete list of all your saved requests.

To instantly run a request, click Run. To refresh all of the API data in the entire spreadsheet, you can run all saved requests simultaneously by clicking Refresh All APIs.

Editing, duplicating, and deleting saved requests

To edit, duplicate, or delete a saved request, go to the Manage tab to see a complete list of all your saved requests.

Then click on the name of the saved request that you want to modify. After you click on the Name, you will be taken to the edit page where you can modify the saved request as you like.

Setting the Request Name & Sheet Name

When editing a saved request in the Manage tab, you’ll notice two new fields that were not available/visible in the Import tab.

The Request Name is the name of your request. This name is visible in the Manage tab and also when creating a scheduled request. Choose an appropriate name that’s easy to remember.

The Sheet Name is the name of the sheet you wish to import data into.

  • Setting a request’s sheet name to the name of an existent sheet will overwrite the data in that sheet.
  • Setting a request’s sheet name to the name of a non-existent sheet will create a new sheet with that name once you run the request. The new sheet will include the requested data.

After you save your API request, you can then head over to the Schedule tab in Apipheny to schedule your saved request to automatically run every hour, day, week, or month.


More API Tutorials

Related Posts