Power BI Zendesk Connector
In this article you will learn how to integrate Using Zendesk Connector you will be able to connect, read, and write data from within Power BI. Follow the steps below to see how we would accomplish that. Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
See also
|
Video Tutorial - Integrate Zendesk data in Power BI
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
Zendesk integration in Power BI - How to configure connection for
Zendesk - Features about
API Driver (Authentication / Query Language / Examples / Driver UI) - Using
Zendesk Connection in Power BI
Create ODBC Data Source (DSN) based on ZappySys API Driver
To get data from Zendesk using Power BI we first need to create a DSN (Data Source) which will access data from Zendesk. We will later be able to read data using Power BI. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
When the Configuration window appears give your data source a name if you haven't done that already, then select "Zendesk" from the list of Popular Connectors. If "Zendesk" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ZendeskDSNZendesk -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Authenticate using Static Token instead of userid / password ([Token Access] option must be enabled under Admin Console > Channel > API > Settings and then Click [ADD API Token] to generate new token. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/settings [Read more..]
Please refer to below API Reference (External Site) link for Token Authentication [Http]https://developer.zendesk.com/rest_api/docs/support/introduction#api-token
Fill in all required parameters and set optional parameters if needed:
ZendeskDSNToken Authentication [Http]https://[$Domain$].zendesk.com/api/v2Required Parameters Domain Fill in the parameter... UserId Fill in the parameter... Token Fill in the parameter... Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... OAuth App must be created under Admin Console > Channel > API > Settings. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/oauth_clients [Read more..]
Please refer to below API Reference (External Site) link for OAuth Authentication [OAuth]https://developer.zendesk.com/rest_api/docs/support/introduction#oauth-access-token
Fill in all required parameters and set optional parameters if needed:
ZendeskDSNOAuth Authentication [OAuth]https://[$Domain$].zendesk.com/api/v2Required Parameters Domain Fill in the parameter... ClientId Fill in the parameter... ClientSecret Fill in the parameter... Permissions Fill in the parameter... RedirectUrl Fill in the parameter... Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... Authenticate using your userid / password (2FA must be OFF and [Password Access] option must be enabled under Admin Console > Channel > API > Settings. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/settings [Read more..]
Please refer to below API Reference (External Site) link for UserID/Password Authentication (2FA must be OFF) [Http]https://developer.zendesk.com/rest_api/docs/support/introduction#basic-authentication.
Fill in all required parameters and set optional parameters if needed:
ZendeskDSNUserID/Password Authentication (2FA must be OFF) [Http]https://[$Domain$].zendesk.com/api/v2Required Parameters Domain Fill in the parameter... UserName (2FA Must be OFF) Fill in the parameter... Password Fill in the parameter... Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Read Zendesk data in Power BI from ODBC
-
Once you open Power BI Desktop click Get Data to get data from ODBC:
-
A window opens, and then search for "odbc" to get data from ODBC data source:
-
Another window opens and asks to select a Data Source we already created. Choose ZendeskDSN and continue:
ZendeskDSN -
Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:
ZendeskDSN -
Finally, you will be asked to select a table or view to get data from. Select one and load the data!
-
Finally, use data extracted from Zendesk API in Power BI reports:
Import Zendesk data into Power BI from SQL Query
If you wish to import Zendesk data from SQL query rather than selecting table name then you can use advanced options during import steps (as below). After selecting DSN you can click on advanced options to see SQL Query editor.
Edit Query / Using Parameters in Power BI (Dynamic Query)

let
vKey=paraAPIKey,
Source = Odbc.Query(
"dsn=ZS-OData Customers",
"SELECT * FROM value WITH (SRC='http://httpbin.org/post',"
& "METHOD='POST',"
& "HEADER='Content-Type:application/json',"
& "BODY=@'{""CallerId"":1111, ""ApiKey"":""" & vKey & """}')")
in
Source
Edit Query Settings after Import
There will be a time you need to change initial Query after dataset import in Power BI. Not to worry, just follow these steps to edit your SQL.
Using DirectQuery Option rather than Import
So far we have seen how to Import REST API data into Power BI but what if you have too much data and you dont want to import but link it. Power BI Offers very useful feature for this scenario. Its called DirectQuery Option. In this section we will explore how to use DirectQuery along with ZappySys Drivers. Out of the box ZappySys Drivers wont work in ODBC Connection Mode so you have to use SQL Server Connection rather than ODBC if you wish to use Live data using DirectQuery option. See below step by step instructions to enable DirectQuery mode in Power BI for REST API data. Basically we will use ZappySys Data Gateway its part of ODBC PowerPack. We will then use Linked Server in SQL Server to Link API Service and then we will issue OPENROWSET queries from Power BI to SQL Server and it will then call REST API via ZappySys Data Gateway.Step-By-Step - How to query Zendesk API in SQL Server
- First read this article carefully, How to query Zendesk API in SQL Server.
- Once linked server is configured we are ready to issue API query in Power BI.
- Click Get Data in Power BI, select SQL Server Database
- Enter your server name and any database name
- Select Mode as DirectQuery
-
Click on Advanced and enter query like below (we are assuming you have created JSON Data Source in Data Gateway and defined linked server (Change name below).
Select * from OPENQUERY(ZENDESK_LINKED_SERVER,'SELECT * FROM Customers')
Select * from OPENQUERY(
ZENDESK_LINKED_SERVER,
'SELECT * FROM Customers'
)
DirectQuery option for Power BI (Read REST API Data Example using SQL Server Linked Server and ZappySys Data Gateway) - Click OK and Load data ... That's it. Now your Zendesk API data is linked rather than imported.
Working with Gateways in Power BI (Schedule Import)
If the data needs to be updated, it is necessary to create a gateway on-premises. In this new section, we will install a Power BI Gateway and in the next section schedule it to update the REST API information.- In the last section, we Published the report. Power BI may ask you to SIGN IN.
- Select the Workspace and select Datasets
- Right-click the report and select Settings.
- The system will ask for a Gateway. Stay here.
-
Use the following link to install a Data Gateway:
https://docs.microsoft.com/en-us/power-bi/service-gateway-onprem
-
Run the installer and press Next
Gateway installer
- Select the option On-premises data gateway (recommended). This option allows access to multiple users and can be used by more applications than Power BI.
- The installer will show a warning message.
- Select the path to install and check the I accept the terms.
- Specify the email address to use the gateway.
- After entering the email, write the gateway name and a recovery key. Make sure to confirm the recovery key.
Manage gateways and configure the schedule
Once that the gateway is installed we will configure it and add the connection strings.- The next step is to go to manage gateway
- In order to get the connection string, we will need the connection string of the ZappySys JSON Driver. In the first section of this post, we explained how to configure it. Press Copy Connection String
- Once that the data is copied, add a New data Source. In Data Source Name, enter the Data Source Name of the ZappySys JSON driver in step 13 and in Data Source Type, select ODBC. In connection string copy and paste from the clipboard of the step 13 and press Add.
- Once added the gateway. You can see the schedule refresh to On and Add another time to add the time where you want to refresh the data.
Create Custom Store Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
Conclusion
In this article we discussed how to connect to Zendesk in Power BI and integrate data without any coding. Click here to Download Zendesk Connector for Power BI and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Zendesk Connector for Power BI
Documentation
Actions supported by Zendesk Connector
Zendesk Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sort By |
|
||||||||||||||||||||||||
Sort Order |
|
||||||||||||||||||||||||
Extra Columns to Include |
|
||||||||||||||||||||||||
External ID for Ticket |
|
Parameter | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) |
|
Parameter | Description |
---|---|
Ticket ID(S) - Use Comma for multiple (e.g. 111,222) |
|
Parameter | Description |
---|---|
User ID(S) - Use Comma for multiple (e.g. 111,222) |
|
Parameter | Description |
---|---|
Organization ID(S) - Use Comma for multiple (e.g. 111,222) |
|
Parameter | Description |
---|---|
Organization ID |
|
Parameter | Description |
---|---|
User ID |
|
Parameter | Description |
---|---|
User ID |
|
Parameter | Description |
---|---|
User ID |
|
Parameter | Description |
---|---|
Organization ID |
|
Parameter | Description |
---|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
Ticket ID |
|
||||||
Sort Order |
|
||||||
Include inline images |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
Ticket ID |
|
||||||
Sort Order |
|
||||||
Include inline images |
|
Parameter | Description |
---|---|
Since (ISO e.g. 2013-04-03T16:02:46Z) |
|
Parameter | Description |
---|---|
activity_id |
|
Parameter | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Search Criteria |
|
||||||||||||||||||||||
Sort By |
|
||||||||||||||||||||||
Sort Order |
|
||||||||||||||||||||||
Extra Columns to Include |
|
Parameter | Description |
---|---|
user_id |
|
Parameter | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sort By |
|
||||||||||||
Sort Order |
|
||||||||||||
Status |
|
Parameter | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sort By |
|
||||||||||||||||||||||
Sort Order |
|
||||||||||||||||||||||
Search Criteria |
|
||||||||||||||||||||||
Status |
|
||||||||||||||||||||||
organization_id |
|
||||||||||||||||||||||
cc_id |
|
Parameter | Description |
---|---|
Attachment ID |
|
Parameter | Description |
---|---|
Attachment ID |
|
Parameter | Description |
---|---|
File Name |
|
File Path (Local) |
|
Token for exising Upload Session |
|
Parameter | Description |
---|---|
Token for exising upload |
|
Parameter | Description |
---|---|
Ticket ID(S) - Use Comma for multiple (e.g. 111,222) |
|
Parameter | Description |
---|---|
Ticket ID to Update |
|
Parameter | Description |
---|---|
Ticket ID for Delete |
|
Parameter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Role |
|
||||||||
permission_set |
|
||||||||
External ID for Ticket |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Other App Integration scenarios for Zendesk
Other Connectors for Power BI
Download Zendesk Connector for Power BI
Documentation
How to connect Zendesk in Power BI?
How to get Zendesk data in Power BI?
How to read Zendesk data in Power BI?
How to load Zendesk data in Power BI?
How to import Zendesk data in Power BI?
How to pull Zendesk data in Power BI?
How to push data to Zendesk in Power BI?
How to write data to Zendesk in Power BI?
How to POST data to Zendesk in Power BI?
Call Zendesk API in Power BI
Consume Zendesk API in Power BI
Zendesk Power BI Automate
Zendesk Power BI Integration
Integration Zendesk in Power BI
Consume real-time Zendesk data in Power BI
Consume realtime Zendesk API data in Power BI
Zendesk ODBC Driver | ODBC Driver for Zendesk | ODBC Zendesk Driver | SSIS Zendesk Source | SSIS Zendesk Destination
Connect Zendesk in Power BI
Load Zendesk in Power BI
Load Zendesk data in Power BI
Read Zendesk data in Power BI
Zendesk API Call in Power BI