Skip to main content
You can use the API tool for an almost unlimited amount of things. Trigger external actions, enrich your data with Large Language Models, send Slack messages, send data to other software tools or get data from other services.
The API tool is an advanced tool. You will call the API endpoint ones for every row in your data - so 10.000 rows = 10.000 API calls. We strongly recommend testing on smaller datasets.You are responsible for respecting rate limits and general terms of use of whatever APIs that you are interacting with.Reach out to us if you need support before using the API tool.
APIs are a method for computers to interact with each other (read more here).There are many types of API methods (GET, POST, PUT, DELETE, etc). You can think of this as different way of interacting. A GET API call asks the other computer to return some data - you might call Mailchimp’s API to return all your campaigns with a GET call. PUT calls are used to update data - you might use a PUT call to update a member in Mailchimp. DELETE calls are used to delete data - you might use a DELETE call to delete a member in Mailchimp. POST calls asks the other computer to generate something. For instance, you might use a POST call to ask OpenAI to generate an AI review score. You could also use POST calls to create new members in Mailchimp.You need to configure a couple of things when using API calls. In almost all methods, you need at least three components:
  1. Method. As discussed above; GET, POST, PUT, DELETE
  2. URL. This describes what you want the computer do do (for instance GET /lists/{list_id}/members to get all your members in the list corresponding to list_id)
  3. Authentication. You need to inform the other computer who you are. Think of this as a key to opening a door

​
Configuration

1

Accept

You must accept our Terms of Use specifying that you are responsible for respecting rate limits and general terms of use of whatever APIs that you are interacting with.
2

Request method

Select the relevant API Method. You can choose between GET, POST, PUT, PATCH and DELETE.
3

Body type (only for POST, PUT and PATCH methods)

Select the relevant body type. This can be either JSON, URL encoded or form data.
4

JSON Body (only for POST, PUT and PATCH methods)

Input your JSON body. You can reference columns in your data like this. This means that for each row in your data, the API will be called with the value of the column in the row.
5

Input URL

Input your URL. You can reference columns in your data like this. This means that for each row in your data, the API will be called with the value of the column in the row.
6

Header (optional)

Add any relevant header key-value pairs. For instance, an Authorization header to authenticate your API call.
7

Parameters (optional)

Add any relevant parameter key-value pairs.
8

Rate limits (optional)

Use these options to respect rate limits. You have four options:
  • Seconds between calls: Wait a certain amount of time between each call. For instance, if you input 0.2 seconds, you will maximum call 5 calls per seconds.
  • Maximum calls per minute: Call a maximum number of calls per minute. For instance, if you input 300 calls, you will call all 300 calls within the minute as fast as possible but no more than 300 calls per minute.
  • Stop after a number of requests: Stop after a certain number of requests. For instance, if you input 1000 requests, you will call all 1000 requests as fast as possible but no more than 1000 requests.
  • Stop after a number of minutes: Stop after a certain number of minutes. For instance, if you input 10 minutes, you will call all 10 minutes as fast as possible but no more than 10 minutes.

​
When To Use

There are too many options with the API tool to list here, but generally you can use it to:
  • Extract data with GET calls
  • Send data with POST calls
  • Update data with PUT calls
  • Delete data with DELETE calls