Access Typeform Data as OData Feeds in Tableau

The CData API Server, when paired with the ADO.NET Provider for Typeform (or any of 200+ other ADO.NET Providers), provides Typeform data as OData Web services. This article will explain how to use the API Server to provide the underlying connectivity to Typeform data in Tableau's business intelligence tool.

Set Up the API Server

Follow the steps below to begin producing secure Typeform OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Typeform

After you deploy the API Server and the ADO.NET Provider for Typeform, provide authentication values and other connection properties needed to connect to Typeform by clicking Settings -> Connections and adding a new connection in the API Server administration console.

Start by setting the Profile connection property to the location of the TypeForm Profile on disk (e.g. C:\profiles\TypeForm.apip). Next, set the ProfileSettings connection property to the connection string for TypeForm (see below).

TypeForm API Profile Settings

Authentication to TypeForm uses the OAuth standard.

To authenticate to TypeForm, you must first register and configure an OAuth application with TypeForm here: https://admin.typeform.com/account#/section/tokens. Your app will be assigned a client ID and a client secret which can be set in the connection string. More information on setting up an OAuth application can be found at https://developer.typeform.com/get-started/.

Note that there are several different use scenarios which all require different redirect URIs:

• CData Desktop Applications: CData desktop applications (Sync, API Server, ArcESB) accept OAuth tokens at /src/oauthCallback.rst. The host and port is the same as the default port used by the application. For example, if you use http://localhost:8019/ to access CData Sync then the redirect URI will be http://localhost:8019/src/oauthCallback.rst.
• CData Cloud Applications: CData cloud applications are similar to their desktop counterparts. If you access Connect Cloud at https://1.2.3.4/ then you should use the redirect https://1.2.3.4/src/oauthCallback.rst.
• Desktop Application: When using a desktop application, the URI https://localhost:33333 is recommended.
• Web Application: When developing a web application using the driver, use your own URI here such as https://my-website.com/oauth.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to the Client Id that is specified in your app settings.
• OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.

When you configure the connection, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

You can then choose the Typeform entities you want to allow the API Server to access by clicking Settings -> Resources.

Additionally, click Settings -> Server and set the Default Format to XML (Atom) for compatibility with Tableau.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Create Real-Time Typeform Data Visualizations

Follow the steps below to create data visualizations based on the remote Typeform data:

1. In Tableau, select 'Connect to data'. In the 'On a server' section, click OData.

   

2. In the resulting wizard, enter the URL of the OData endpoint for the API Server. Append the name of the table you want to access to the OData entry URL. For example:

   https://your-server/api.rsc/Tags
3. Select the 'Use a Username and Password' option and enter the username and password of a user who has access to the API Server.

4. Tableau uses the table metadata exposed by the API Server to detect dimension and measure columns.

   

5. To view the Typeform data, right-click under the table name in the Data section of the dashboard and select the View Data option. The Typeform data will appear in Tableau.