Request Settings

When creating an API request in the Apipheny add-on, you can customize how it functions by toggling certain options:

There are currently 3 options you can choose from:

  1. Append Mode
  2. Include Date
  3. Trim Sheet

You can toggle these options on or off depending on how you want your data to be presented.

Here’s a video tutorial for a quick and easy explanation:

1. Append Mode

Whenever Apipheny performs a GET request or POST request, it overwrites current data in your sheet with the new data, in whichever sheet you choose to import the data into. Toggling Append Mode on causes your data requests to add new rows of data to the end of the current sheet instead of overwriting the current data.

If you like keeping record of historical data, consider enabling this option.

2. Include Date & Time

Whenever Apipheny performs an API request, it imports only the data included in the specified endpoint. Often, a datestamp will not be included in the received data. Toggling Include Date on causes Apipheny to insert an extra column that includes the date so you can tell when each request was performed.

If you deal with time-sensitive data, such as stock or cryptocurrency prices, consider enabling this option.

Tip: If you want to see the exact date and time a cell was added or modified in your sheet, right click on the cell and then click Show edit history to view date and time metadata.

3. Trim Sheet

When working in Google Sheets, your sheet may contain blank columns and rows. This is especially true if you create a brand new sheet. Toggling the Trim Sheet option on for your API request cleans up your sheet by removing all the blank columns and rows before inserting your API data.

4. Inherit Values

Use this feature to inherit data from parent JSON elements to their child elements, so rows representing child elements contain the same values as the rows representing their parent elements.

In other words, enable this option to fill up all the empty cells in your spreadsheet. The empty cells will be replaced with the value from the previous row.

Empty cells can cause issues with reporting and pivot tables, so enabling this option can help resolve any issues like that.

Editing your request settings

There’s two places in Apipheny where you can toggle these settings on or off, either in the Import tab or the Manage tab.

In the Import tab, you’ll see this option when you scroll down.

In the Manage tab, click on the name of the saved request you wish to edit, and then scroll down and you’ll see the option to enable or disable this feature:


More API Tutorials

Related Posts