Access Zendesk Data as OData Feeds in Tableau

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

Set Up the API Server

Follow the steps below to begin producing secure Zendesk 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 Zendesk

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

Connecting to Zendesk

To connect, set the URL and provide authentication. The URL is your Zendesk Support URL: https://{subdomain}.zendesk.com.

Authenticating to Zendesk

You can authenticate using the Basic or OAuth methods.

Using Basic Authentication

To use Basic authentication, specify your email address and password or your email address and an API token. Set User to your email address and follow the steps below to provide the Password or ApiToken.

• Enable password access in the Zendesk Support admin interface at Admin > Channels > API.
• Manage API tokens in the Zendesk Support Admin interface at Admin > Channels > API. More than one token can be active at the same time. Deleting a token deactivates it permanently.

Using OAuth Authentication

See the Getting Started guide in the CData driver documentation for an authentication guide.

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 Zendesk 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 Zendesk Data Visualizations

Follow the steps below to create data visualizations based on the remote Zendesk 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/Tickets
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 Zendesk data, right-click under the table name in the Data section of the dashboard and select the View Data option. The Zendesk data will appear in Tableau.