REST API Connector

This connector uses the Tableau JDBC REST API driver to fetch data from REST APIs over HTTP GET, supporting both JSON and CSV response formats. Transform your API data into actionable insights, analyze campaign performance, customer engagement metrics, and more—all within Tableau's powerful analytics environment.

The REST API Connector provides the following capabilities:

• Data Fetching: Retrieve data from REST APIs over HTTP GET requests
• Response Format Support: Handle JSON or CSV response formats with:
  • JSONPath to records configuration
  • CSV delimiter configuration
• Authentication Modes: Support for multiple authentication methods:
  • Basic authentication
  • Bearer token authentication (access token)
  • OAuth (authorization code flow via Tableau, supporting access token and refresh token)
• HTTP Configuration:
  • Custom HTTP headers
  • HTTP connection timeout settings
  • TLS certificate validation control
  • Pagination support (offset/limit) via the extension framework
• Table Configuration: Configure JDBC table names for API endpoints
• Multiple REST APIs: Reference multiple REST API endpoints and join them through relationships

Install the JDBC Driver:

• Download the JDBC REST API driver from the Driver Download page
• Move the .jar file to the following directory:
  • Windows: C:\Program Files\Tableau\Drivers
  • macOS: /Users/[user]/Library/Tableau/Drivers
  • Linux: /opt/tableau/tableau_driver/jdbc
• Launch Tableau Desktop (2023.3 and later):
  • Navigate to Connect → To a Server and select REST API

Note: This connector is extract-only, meaning data must be extracted into Tableau first. After connecting to your REST API data source, navigate to the Worksheet page and refresh the extract using Data → Refresh All Extracts...