The Zendesk Support plugin allows you to easily visualize data from Zendesk to see how agents and support teams are performing, find bottlenecks in your process and get a handle on KPIs.
For more information about what this plugin does and the data streams it retrieves, see:
To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.
You can also add a data source by clicking Add data source on the Settings > Data Sources page, but pre-built dashboards are not added when using this method.
SquaredUp can be configured to access Zendesk by either clicking the Sign-in button to log in using your Zendesk login credentials or by supplying a Zendesk username and API key.
If you want to authenticate using a username and API key, you will need to generate both of these before getting started. API keys can only be generated by a Zendesk admin, so make sure you login to Zendesk with Admin credentials.
Once generated, they can be used in conjunction with a specific user account, and it is the role of the user account that sets the permissions granted.
Generating API keys and adding users (called Team Members by Zendesk) are performed in the Admin center. To access the Admin center, log in to Zendesk with an account that has the Admin role, then click the apps icon in the top-right corner and select Admin Center.
The API key generated earlier can be used with any user account, the permission level that is granted is dependent on the user account specified.
The Zendesk data source requires a permissions level of Agent or higher. To use the Customer Satisfaction (CSAT) data stream the user must be an Admin user.
To create a user account for this purpose, Zendesk provides generic documentation here, or follow the below steps:
From the Zendesk Admin Center navigate to People > Team > Team Members.
Click Create Team Member in the top corner of the window.
Enter the Name and Email address of the user.
In the Assign role section, select a role of Agent or higher.
Click Save.
Navigate to the inbox of the created user and verify their email address as valid before attempting to use it.
Display name: Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
Organization name: Enter the organization name found in your Zendesk URL <organization>.zendesk.com. Don't enter the .zendesk.com part, just the organization name in lower case.
Authentication: Select how you want to authenticate the plugin's connection to Zendesk. Choose from the following:
Sign-in button: Click the Sign in with Zendesk button to authenticate using OAuth 2.0. You are redirected to the Zendesk sign-in page, where you are required to log in using your Zendesk credentials. You must then click Allow when the Allow SquaredUp to access your Zendesk account? prompt displays. Once authenticated, you are returned to the SquaredUp plugin configuration page.
Username: Zendesk calls its users Team members. Enter the team member’s email address that you would like the data source to use the permissions of. If you want to use the Customer Satisfaction (CSAT) data stream then this user must be an Admin level user.
API Token: Enter the API Token. This is used in place of a password and can only be generated by a Zendesk admin. An API token can be used by any user regardless of which account generated it.
Import Organizations: Select to import your Zendesk organizations as objects. Zendesk organizations are typically collections of your end users, but they can also include team members.
Import Organizations with Personal Email Addresses: Select to import your Zendesk organizations not linked to specific domains as objects. Typically these are organizations based around a single email address and can exist in great numbers.
Import Specific Tags: By default, SquaredUp only automatically imports tags that have been used in the last 60 days. If you would like to always import particular tags (even if they have not been used recently), then select this checkbox and specify those tags in the dropdown.
Restrict access to this data source: You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.
Install dashboards: Select whether you would like to install pre-built dashboards and perspectives with the data source. By default, this is set to on.
Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.
Testing passed – a success message will be displayed and then the configuration will be saved.
Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
You can edit any data source configurations at any time from Settings > Data Sources.
The following errors or warnings may be displayed while using the data source. If you encounter an error, refer to the guidance below or contact [email protected] for assistance.
Test
Error if failed
Troubleshooting
Check Zendesk URL is valid
Failed to create a valid url using <the URL created from your organization name>. Please check your organization name.
Check the organization name is correct, see below for more
Check username and token are valid
Your credentials could not be verified. Please check your username and token.
Check username is valid email address and has Agent or higher role and that the API token is correct and valid.
A failure was thrown by Zendesk that doesn’t match any other test
An error occurred. Please contact support.
Try the test again, if you still see the issue, take note of the support code and contact [email protected].
Check organization name is valid
Your organization could not be verified. Please check your organization name.
Check your organization name is correct. This is the part of your Zendesk URL before .zendesk.com when you are logged into Zendesk.
There are several states that all data sources can be in:
Connected: The last data source index was successful. Indexing happens automatically every 12 hours
Running: Indexing is in progress, if this is the first time the data source has connected to the source platform you should wait for this to complete to ensure all dashboards work without issues
Warning: When something went wrong but that wasn’t terminal for the data source, meaning indexing was successful for some of the objects the data source and some data sources should work. If you hover over Move info you will be shown the reason for the warning
Error: The last graph index failed. If you hover over Move info you will be shown why. Note that each time a data source runs it refreshes the index.
Once you have successfully connected to the Zendesk data source, SquaredUp sets up the data source by installing data streams and pre-built dashboards (if you chose to do so), and indexing objects which are used by data streams for scoping.
You can click Run in background, but you won't be able to see any data on the dashboards until the indexing is complete.
To check whether indexing has completed, click on the data source name and look at the data source status in the top left corner. If it says Connected then indexing has completed.
Ticket forms contain a pre-configured set of fields users should fill in to submit a ticket in Zendesk. Read more.
New Tickets
Active Tickets
On-Hold Tickets
Custom Ticket Search
Open Tickets
Pending Tickets
Solved Tickets
Tickets by Created Date
Tickets by Updated Date
Used by :: Brand
Type
Description
Data streams that can scope to this object
Relationships
User
Represents a Zendesk user account, called a Team Member or Agent in Zendesk itself. Read more.
New Tickets
Active Tickets
On-Hold Tickets
Custom Ticket Search
Open Tickets
Pending Tickets
Solved Tickets
Tickets by Created Date
Tickets by Updated Date
Member of :: Group
Users
Users and people are essentially equivalent terms; it's the broadest definition for all people who use your Zendesk.
New Tickets
Active Tickets
On-Hold Tickets
Custom Ticket Search
Open Tickets
Pending Tickets
Solved Tickets
Tickets by Created Date
Tickets by Updated Date
View
Views are a way to organize your tickets by grouping them into lists based on certain criteria.
For example, you can create a view for unsolved tickets that are assigned to you, a view for new tickets that need to be triaged, or a view for pending tickets that are awaiting response.
Using views can help you determine what tickets need attention from you or your team and plan accordingly.
Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.
While creating a tile you can tweak data streams by grouping or aggregating specific columns.
Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.
Data streams can be either global or scoped:
Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").
The following data streams have configurable Parameters.
Data stream
Description
Parameters
All Tickets
Gets all your Zendesk tickets. Use the following Parameters to build a query that returns specific tickets:
Use the following fields to filter which tickets are returned:
Type: Select the type of the tickets to return.
Priority: Select the priority level of the tickets.
Status: Select the status of the tickets.
Channel: Select the channel the tickets were created in.
Use Timeframe: Select this check box to filter results by applying the dashboard timeframe to a selected field. Use the the Apply timeframe to field dropdown that displays to do so.
Filter by Requester: Select this checkbox if you want to select specific requesters to filter by. Use the Requester dropdown that displays to do so.
Show Count Only: Select this check box to return a simple count of the number of tickets returned by the filter for the specified collection.
Include: Select additional field details to include.
Include Custom Fields: Optionally, select this check box if you want to select additional custom fields in the returned data. Use the Custom Fields dropdown that displays to do so.
Custom Ticket Search
Allows you to type a Zendesk search query. Any objects you scope can be inserted into your query using mustache syntax {{}}
As an example, if you scope to all users and want to search for tickets in state greater than new you would type:
Type:ticket status>new assignee:{{sourceId}}
sourceId is replaced by the objects you scoped.
Search Query: Enter a ticket search query.
Show Count Only: Select this to return a simple count of tickets in scope.
Customer Satisfaction
Returns customer satisfaction (CSAT) scores for all tickets in your organization.This data stream will only work if the Zendesk data source is configured with a user that is a Zendesk Admin.When configuring the tile you can optionally choose Parameters > Filter at Source to filter on the property Score.The property Score is converted to a RAG color and displayed as State.
Filter at Source: Select to allow filtering by CSAT score.
Tickets by View
Return tickets that are present in a view.
Show Count Only: Select this to return a simple count of tickets in the collection.
