REST API

Table of Contents

Table of Contents

1. Using REST API as a Data Source

1.1 Basic Parameters

To connect a REST API as a Data Source, fill in the following parameters (Image 1):
Parameter
Value
HTTP Method
GET or POST
API Response Format
Specify a response format of the endpoint
Records Root JSONPath
Specify the JSON path for the array of results, where each record is an object.
If your array has a parent node, you will use that.
If it does not have a parent node, the CLI code will place your array in the $.data root path, which is what this parameter should be set to.
Path to Iterate
Specify the path to Iterate.
API Endpoint URL
API endpoint, including URL parameters like API key
Next Page URL JSON Path
Specify the path for the next page URL. This is only relevant for APIs that use cursor pagination
Image 1: Parameters. (Click to enlarge)

1.2 Schema

  1. 1.
    Add in your applicable columns (Image 2). Review the documentation here for information on the column types available.
Image 2: Schema Columns

1.3 Other Sections

You can add in other sections by selecting the "Add a Section" drop down, and selecting from the list (Image 3). Note that a pagination block is mandatory.
Image 3: Other Sections

1.3.1 Filter

Adding a filter section allows you to enter a CQL filter statement for your results (Image 4). See here for more information on adding a Filter.
Image 4: Adding a Filter Section

1.3.2 Auth Request

You can add in an Auth Request (Image 5) by reviewing the documentation here.
Image 5: Adding an Auth Request

1.3.3 Request Headers

You can add in Request Headers (Image 6) by reviewing the documentation here.
Image 6: Adding Request Headers

1.3.4 Body

You are able to use this section to add body content (Image 7):
Image 7: Adding in Body Content

1.3.5 Pagination

A pagination block is mandatory (Image 8). Review the documentation here for more on pagination blocks.
Image 8: Selecting your type of pagination