Connecting to Airtable#
First Steps with Airtable#
Set up an account with Airtable.
Cost
There are both free and paid options for this API.
Rate Limits
Airtable limits the number of requests each API key can make per second. Current rate limits are available in Airtable's documentation.
How to Connect DataDistillr to Airtable#
To set up a data source connection for Airtable, you will need to have:
- A unique name for your data source connection to be used in queries.
- The Base ID (Called 'Project Path' on the form).
- The API Key generated through your Airtable account.
Data Source Form#
To locate the Airtable form, follow the steps in Connecting Your Data to DataDistillr. When you get to the window to choose the data source type, select API as shown below.
On the API screen, select Airtable from list of API forms as shown in the image below.
The following form will appear. Instructions are below on how to find the information required to fill each field on the Airtable API form.
Once you have filled out all the fields, press the green 'Save' button, and your API will be connected!
Name#
Enter any name that will help you recognize this data source from within your query window.
Acceptable characters include
- lowercase alphanumeric characters
- underscores
Base ID (Project Path)#
After logging in, you can access your Base ID by navigating to 'Bases' along the top panel and clicking on your workspace as shown in the image below.
You can find the Base ID (Called Project Path in our form) in the Highlighted section of the Base URL shown below, and enter this into the Airtable Data Source Form as the 'Project Path'.
https://airtable.com/
YOUR_BASE_ID/tblPI1Mclv7pqrqDq/viwCAMdqRwJpFOlxl?blocks=hide
API Key#
To generate your API Key, navigate to your Account overview where you will have the option to generate an API Key as highlighted below. Copy this API Key and enter into the Airtable Form.
Endpoints#
The table below shows a list of endpoints available to connect to within the DataDistillr application. If you need to connect to any endpoints not listed in the table below, please use the Custom API Form.
Endpoint | URL Params | Optional | Description |
---|---|---|---|
tables |
TableName | priority sources tags unaggregated exclude_aggregate page |
Returns the table and its cells |
Nav Tree#
The endpoint above will display as follows in the nav tree once your API has successfully connected.
Sample Queries#
The following queries are intended to help you get started, and make life simpler querying within your API.
For the following examples, suppose that my Airtable API data source was called myairtableapi
, and I want to query
an endpoint. The endpoint goes after the ClickUp data source name:
Get Tables Endpoint#
Suppose you have a table called Form Responses 1
. In the table there are several columns including ID
and fields
.
In order to access the values in the fields column you have to query their keys specifically as so.