How do I connect Klipfolio and Jira?

You can set up a connection between Klipfolio and your Jira data to display your bug tracking and agile project management metrics on a dashboard.

This article includes:

Note: The Klipfolio connector works with Jira Software Cloud. We do not support Jira Software Server.

What options do I have for visualizing my Jira data?

Create data visualizations based on pre-built options or build your own. The choice is yours!

Pre-built by Klipfolio

Take advantage of our pre-built data sources to gather the data most meaningful to you.

  • Jira pre-built data sources: Data sources provide the foundation for Klip® building, so we suggest you create a data source as a first step (before building Klips and adding them to your dashboard). Our pre-built data sources focus on the most sought-after Jira data and are found on the Service Connectors page, available from this link or from your list of data sources. When you select a service connector from this page, the data source for that service is automatically added.

Custom-built by you

Taking the time to learn how to create your own data sources and Klips unlocks your data and enables you to control, manipulate, and transform it, leading you to unprecedented insights into your business.

  • Custom data sources: When you create a custom data source, you can either use the pre-built data source as a starting point from which to write your own query or you can write your own queries from the ground up and build a data source from scratch. You create custom-built data sources in the Service Connectors page, accessible from this link or from your list of data sources.
  • Custom Klips: Using our Klip Editor, you can construct and manipulate your data, including integrating multiple data sources, to produce unique, custom-built data visualizations. You create custom Klips from either your list of Klips or your Dashboard.

Regardless of whether you choose pre-built, custom-built, or a combination of both, before you can start building Klips and dashboards you need to connect to Jira data in Klipfolio.

How do I connect to Jira data in Klipfolio?

To connect your Jira data to Klipfolio, you will need an API Token, the email address associated with your Jira account, and your Jira Base URL (for example, skynet.atlassian.net).

To get the right data from Jira, you use your Jira Base URL in the queries provided by Klipfolio or in your own query when building data sources.

How do I find my Jira API Token?

To find your Jira API Token:

  1. Log in to your Atlassian account to access the Atlassian API Token Manager.
  2. Click Create API token.
  3. Enter a Label for your token and click Create.
  4. Click Copy to Clipboard.
    Note: We recommend saving a copy of your API Token. After closing this dialogue, you won’t be able to view it again. If needed, you can create a new one.

How do I add a Jira pre-built data source?

To add a Jira pre-built:

  1. Navigate to the Service Connectors page in Klipfolio and choose Jira from the list.
  2. Select a pre-built data source from the left section of the Pick a Data Request page.
  3. Enter the Email associated with your Jira account and your API Token, and click Next Step.
  4. On the Configure Data Source page, enter your Jira Base URL and select your Service Desk from the drop-down list if applicable.
  5. Click Submit or, if you want to modify the pre-built data request, click Switch to Custom settings.
    Note: If you switch back to the Basic settings page after making changes in the Custom settings page, your changes will not be saved.

If you clicked Switch to Custom settings:

  1. On the Configure Data Source page, modify the Query URL to get the data you want. You can use the existing information in the Query URL text box as a base. It was auto-filled based on the pre-built data source you selected on the Pick a Data Request page.
  2. Click Submit.

Note: In addition to your unmodelled data source, you can create a modelled version of your data source at this stage. To create a modelled data source, ensure that the checkbox next to Model this data source is selected before clicking Continue.

To learn more about creating a modelled data source, click here.

How do I add a Jira custom-built data source?

To create a Jira custom-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose Jira from the list.
  2. On the Pick a Data Request page, click Create a custom Jira data source.
  3. Enter the Email associated with your Jira account and your API Token, and click Next Step.
  4. Adjust the Query URL information, as noted on the Configure Data Source page, to replace any generic placeholder query information with your own.
    For example, replace <yourJiraUrl> with your Jira Base URL.
  5. Edit the Query URL further to return the data you need. Refer to the Jira API documentation for details.
  6. Click Submit.

Note: In addition to your unmodelled data source, you can create a modelled version of your data source at this stage. To create a modelled data source, ensure that the checkbox next to Model this data source is selected before clicking Continue.

To learn more about creating a modelled data source, click here.

If you want to edit a data source that you already created, check out How to edit or reconfigure a data source, and get step-by-step instructions.

How do I create a Jira data source from scratch?

You can choose to build a data source from scratch. Klipfolio connects to hundreds of services in the cloud that have a REST API. If you take the time to learn your service’s API to create queries for the data you want, your possibilities are endless. Here’s a quick overview video on APIs and Klipfolio:

Klipfolio API's 101

If you need assistance using APIs, enlist a data analyst or developer.

Refer to the Jira API documentation to discover more data requests.

When you are happy with your query, click Submit, and then save and name your new data source. You're now ready to use it to build a Jira Klip.

See the reference table below for API related information and sample queries.

API Documentation Jira API documentation

Authentication Method

Basic HTTP Authentication
Response Format JSON
Sample Queries

Get a list of queues in a Jira Service Desk (max. 50):

https://<yourDomain>.atlassian.net/rest/servicedeskapi/servicedesk/<ServiceDeskId>/queue?includeCount=true

Get a list of open customer requests:

https://<yourDomain>.atlassian.net/rest/servicedeskapi/request?requestStatus=OPEN_REQUESTS&expand=serviceDesk&expand=requestType&limit=100

How do I create a Jira custom Klip?

You create custom Klips from either your list of Klips or your Dashboard. You choose a data visualization format, for example, a pie chart, gauge, or table, and decide whether you want to use an existing data source or create a new one. In the Klip Editor, there are limitless opportunities to modify, relate, and display your data. See the following related articles for more information and get building!

Related Links

Have more questions? Submit a request