Pagination

Many API endpoints that return a list of data split that data up into separate "pages", where each page is a subset of the data. This is called pagination.

Data Fetcher handles the most common types of pagination:

1. Page

A page parameter is set in the URL to tell the API which page number of the data you want. e.g.

• Page 1:http://example.com/?page=1

• Page 2:https://www.example.com/?page=2

2. Offset

Offset and limit parameters are set in the URL to tell the API which slice of the data you want. e.g.

• Page 1:https://www.example.com/?offset=0&limit=50

• Page 2:https://www.example.com/?offset=50&limit=100

3. Cursor

After the first request, a parameter in the URL is set to an ID from the previous response to tell the API where to start the next page. e.g.

• Page 1:http://www.example.com

• Page 2:https://www.example.com/?starting_after=cus_IOCwDqeBZGGsrF

4. Next URL

After the first request, the API returns a field which contains the entire URL for the next page of data. This URL is used to make the next request. Sometimes this will be in the response headers as a header called Link . The examples here could be any of the previous three examples. The difference is how the next URL is accessed.

5. Offset Body

Offset and limit parameters are set in the request body to tell the API which slice of the data you want. e.g.

• Page 1 body: { "startRow": 0, "rowLimit": 1000 }

• Page 2 body: { "startRow": 1000, "rowLimit": 1000 }

6. Cursor Body

After the first request, a field value in the request body is set to an id from the previous response to tell the API where to start the next page. e.g.

• Page 1 body: { "pageToken": "" }

• Page 2 body: { "pageToken": "cus_IOCwDqeBZGGsrF" }

7. Header

A header is sent with each request. The value of the header is incremented each time. e.g.

• Page 1 headers: page 1

• Page 2 headers: page 2

8. Path

A path parameter in the request URL is incremented with each request to determine the page. For example, in the URL https://api.example.com/stocks/{page} the {page} path parameter is replaced with the page. e.g.

• Page 1:https://api.example.com/stocks/1

• Page 2:https://api.example.com/stocks/2

9. GraphQL Cursor

The GraphQL query takes a cursor argument, set to an ID from the previous response, to tell the API where to start the next page. E.g., for this GraphQL query:

query($after: String) {
  pullRequests(first: 100, after: $after) {
    nodes {
      id
      createdAt
      number
      title
    }
    pageInfo {
      endCursor
      hasNextPage
    }
  }
}

• Page 1: after would be set to null

• Page 2: after would be set to the endCursor value (or the final id value for some APIs).

Some API documentation will have a Pagination section that explains the pagination type you should use for all endpoints. If not, it will be explained in the documentation for the specific API endpoint.

Select pagination type

• On the create request screen, click to open the advanced settings.
• Under Pagination, select the pagination type using the dropdown. You can set it to "None" to turn off pagination.

Set the number of pages to fetch

Each page that is fetched will use 1 out of your monthly workspace runs.

• After selecting a pagination type, these options will become visible:

  
• Enable Fetch all pages to paginate through every page until no/fewer items are returned. This can sometimes cause infinite runs if the API response always returns some data, so you will need to test it.

• Alternatively, you can enter a maximum number of pages to fetch:

• When you've entered a maximum number of pages, Data Fetcher will stop paginating whenever no/fewer items are returned. You can force pagination up to the maximum by clicking next to the number input and enabling Keep paginating when no/fewer items returned on the modal that opens.

Set up page pagination

• Set the pagination type to "Page".
• Set the number of pages to fetch.
• Enter the name of the page parameter. This is nearly always called "page" but some endpoints may use a different name:

  

If the API supports it, you can set a page size parameter and size, so that Data Fetcher knows when to stop paginating more reliably.

• Set the name of the page size parameter:

• Set the page size:

Set up offset pagination

• Set the pagination type to "Offset".
• Set the number of pages to fetch.
• Enter the name of the Offset parameter. This is often called "offset" but some endpoints may use a different name:

  
• Enter the name of the Limit parameter. This is often called "limit" but some endpoints may use a different name:

  
• Enter the numerical Limit value. This is the number of entities that are fetched in each page. The offset value will be increased by this amount for each request.

  
• Optionally, enter a Starting offset. If you leave this blank, 0 will be used.

Set up cursor pagination

• Make sure you import the cursor field (usually an ID) on the response field mapping and run the request once to create the cursor field in the output table.
• Set the pagination type to "Cursor".
• Set the number of pages to fetch.
• Enter the name of the cursor parameter:

  
• Select the Cursor field from the output table fields using the dropdown:

If the API supports it, you can set a page size parameter to help Data Fetcher know when to stop paginating.

• Set the name of the page size parameter:

• Set the page size:

Set up next URL pagination

• Make sure you import the cursor field (usually an id) on the response field mapping and run the request once to create the next URL field in the output table.
• Set the pagination type to "Next URL".
• Set the number of pages to fetch.
• Select the Next URL field from the output table fields using the dropdown:

If the API supports it, you can set a page size parameter to help Data Fetcher know when to stop paginating.

• Set the name of the page size parameter:

• Set the page size:

Set up next URL pagination using Link header

• Set the pagination type to "Next URL".
• Set the number of pages to fetch.
• Enable "Or, use link in response header".

Set up offset body pagination

• Set the pagination type to "Offset Body".
• Set the number of pages to fetch.
• Enter the Offset path for the request body. This uses JSONPath.
• Enter the Limit path for the request body. This uses JSONPath.
• Enter the Limit value.

• Optionally, enter a Starting offset. If you leave this blank, 0 will be used.

Set up cursor body pagination

• Make sure you import the cursor field (usually an id) on the response field mapping and run the request once to create the cursor field in the output table.
• Set the pagination type to "Cursor Body".
• Set the number of pages to fetch.
• Enter the Cursor path for the request body. This uses JSONPath.
• Select the Cursor field from the output table fields in the dropdown:

Set up header pagination

• Set the pagination type to "Header".
• Set the number of pages to fetch.
• Enter the name of Page header, e.g. "page".

• Optionally, enter a Page size header.

• Optionally, enter a Page size.

• Optionally, enter a Starting page. If you leave this blank, 1 will be used.

Set up path pagination

• In the URL input, enter the URL with {} around the path parameter, e.g. https://api.example.com/stocks/{page} .

• Set the pagination type to "Path".
• Set the number of pages to fetch.
• Enter the Path parameter, e.g. "page" in this example.

• Optionally, enter a Page size parameter.

• Optionally, enter a Page size.

• Optionally, enter a Starting page. If you leave this blank, 1 will be used.

Set up GraphQL Cursor Pagination

• In the Body -> GraphQL -> Query section, enter the GraphQL query, including any pagination parameters.

• There is no need to add the pagination parameters in the GraphQL -> Variables section. Data Fetcher will do this automatically.

• Set the pagination type to "GraphQL Cursor".
• Set the number of pages to fetch.
• Enter the Cursor variable name.

• Select the Cursor field. You should already have created this field in Airtable and / or mapped the relevant response field to this field. Typically, this is an ID field or a pagination cursor field in the response.

• You can optionally enter a Page size variable or just a Page size value. This will help Data Fetcher know when to stop paginating if you have selected the Fetch all pages option.