How do I connect Klipfolio and Lighthouse?

You can set up a connection between Klipfolio® and your Lighthouse data to display your task and issue tracking metrics on a dashboard.

This article includes:

What options do I have for visualizing my Lighthouse 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.

  • Lighthouse 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 Lighthouse 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 Lighthouse data in Klipfolio.

How do I connect to Lighthouse data in Klipfolio?

To connect your Lighthouse data to Klipfolio, you will need your Lighthouse API Token and Subdomain.

To get the right data from Lighthouse, you use your Lighthouse API Token and Subdomain in the queries provided by Klipfolio or in your own query when building data sources.

How do I find my Lighthouse API Token and Subdomain?

To find your Lighthouse API Token:

  1. Log in to your Lighthouse account.
  2. At the top right of the page, click your username.
  3. In the right navigation bar, find Your API Tokens.
  4. If you don't have any existing API Tokens, create a new one by choosing an account under Add An API Token.
  5. Enter a Label for your token and choose a level of access.
  6. Click Create and copy your API Token.
  7. Copy your API Token.

To find your Lighthouse Subdomain:

  • Your Lighthouse Subdomain can be found in the URL of your Lighthouse account. It is the first part of your Lighthouse web addresss (yourSubdomain.lighthouseapp.com).

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

To add a Lighthouse pre-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose Lighthouse from the list.
  2. Select a pre-built data source from the left section of the Pick a Data Request page.
  3. On the Configure Data Source page, enter your Lighthouse API Token and Subdomain.
  4. 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 create a Lighthouse custom-built data source?

If you choose to create a custom Lighthouse data source, you may need to enter a Project ID into a specific spot in the query.

To find your Lighthouse Project ID:

  1. Navigate to the Service Connectors page in Klipfolio and choose Lighthouse from the list.
  2. On the Pick a Data Request page, click Projects.
  3. Enter your Lighthouse API Key and Subdomain.
  4. Click Submit.
  5. Copy your Project ID from the query results.

To create a Lighthouse custom-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose Lighthouse from the list.
  2. On the Pick a Data Request page, click Create a custom Lighthouse data source.
  3. 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 <yourSubdomain> with your own Subdomain.
  4. Edit the Query URL to return the data you need. Refer to the Lighthouse API documentation for details.
  5. Under Query Parameters, at Parameters > Value, replace the <yourApiKey> placeholder with your API Token.
  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 Lighthouse 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 Lighthouse 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 Lighthouse Klip.

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

API Documentation Lighthouse API documentation

Authentication Method

API Key Authentication
Response Format JSON
Sample Queries

To get a list of tickets for a project:

https://uottawa.lighthouseapp.com/projects/<{#project_id}>/tickets.json

To get a list of milestones for a project:

https://uottawa.lighthouseapp.com/projects/<{#project_id}>/milestones.json

How do I create a Lighthouse 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