Response Viewer

Apipheny is an API connector for Google Sheets.

You can use Apipheny’s Response Viewer to preview the API fields before you import it.

The Response Viewer allows you to:

  • Preview the fields of the API data before you import it into your sheet
  • Exclude fields you don’t want to import
  • Customize the column heading name
  • Filter your import for specific values

Opening the Response Viewer

To use the Response Viewer, simply enter your API request and then click the Preview button at the bottom of the Apipheny sidebar.

When you click the Preview button, you will be asked to confirm whether you would like to run the API to get the fields.

Using the Response Viewer

For this example, we are using this API: https://api.coinbase.com/v2/prices/ETH-USD/buy

This is what the raw API data looks like:

{"data":{"base":"ETH","currency":"USD","amount":"1999.32"}}

The “fields” of this API are:

  • data
  • base
  • currency
  • amount

Here’s what the data looks like from a hierarchal perspective:

When we enter the API URL in Apipheny and click the Preview button, here is what we see inside the Response Viewer:

Field

These are the API fields. Each field turns into a column when imported into Apipheny.

You can select and deselect the fields that you would like to import into your sheet. If you don’t want to import a certain field (if you want to exclude a certain column), simply deselect that field.

JSON is a hierarchical structure. You can select and deselect not only at an individual field level but also at a group level. Use the +/- to expand or collapse grouped fields.

Source Field Name

The Field Name is the name of the field from the raw API data, using dot notation format for nested fields.

This is how the column heading will show up if you do not change it.

You can use this field to refer to the structure defined in your API specification

Column Heading Name

The Heading Name is the name of the column heading you wish to see in your sheet.

If you do not modify the Heading Name, it defaults to the Field Name.

Filter

You can use the Filter feature to specify the filter you want to apply to each of the fields.

The filter will be applied to the data retrieved from the API before being imported into your sheet.

Note that a filter is applied to each row of data. It is an “AND” filter and not an “OR” filter.

Value

If you apply a filter, you can specify the value of the filter in the Value field.

Save & Close

After you’re finished customizing your API import in the Response Viewer, simply click the Save button to save the settings.

Then click the close button to close the Response Viewer.

Then you can proceed with running your API request and getting your custom data import in your Google Sheet.



Popular API Tutorials


API Knowledge

What is an API?

What is an API URL?

What are parameters?

What is an endpoint?

What is an API key/token?

What is basic authentication?

What are headers?

What is a GET request?

What is a POST request?

Import JSON to Google Sheets


SEO by SearchCyrus