Search results

Connecting Bold BI to Lighthouse data source

Bold BI dashboard designer supports connecting Lighthouse web services through REST API.

Choose Lighthouse data source

To configure the Lighthouse data source, follow the below steps:

  1. Click the Data Sources button in the configuration panel to add a new data connection.

    Data source icon

  2. Click CREATE NEW to launch a new connection from the connection panel.

  3. Select the Lighthouse connection in the connection panel.

    Choose data source

NOTE: You can also create a data source from the home page by clicking the Data Sources menu from left menu panel and Create Data Source from the data sources page.

Choose data source from server

Create Lighthouse data source

Once you click the Lighthouse data source, the NEW DATA SOURCE configuration panel opens. Follow the below steps to create Lighthouse data source.

  1. Enter a name and description (optional) for the data source.

  2. Enter a valid Lighthouse REST API endpoint in the URL textbox. Refer the Lighthouse API documentation for more details.

    Example: https://<:domain>.lighthouseapp.com/projects

  3. Select GET method for the REST API in Method combo box.

  4. In Max Rows, enter the maximum number of rows to be fetched from the Lighthouse data source. This value is used to fetch the data from Lighthouse data source via pagination.

  5. Choose a time interval for Refresh Settings using the combo box, to trigger the Rest API request periodically to keep the data in sync with our dashboard.

  6. Select JSON or XML data type in Data Format combo box.

  7. Replace <:X-LighthouseToken> under Headers with a valid Access Token.

  8. Choose None under Authentication Type as authentication is done through header.

You can also edit the connection information set here using the Edit Connection option.

How do I get Access Token for connecting Lighthouse data source?

  1. Login to your Lighthouse account.
  2. Go to Profile -> Account. Find your API token under YOUR API TOKENS.
  3. Use CREATE AN API TOKEN, if you do not have a Lighthouse token yet.
  4. Use this API Token as Access Token in Lighthouse data source in Bold BI Dashboard.

Reveal API Token

Additional information

Max Rows Most of the REST APIs return only fewer data on a single API request. To pull the amount of data you need, set a value in this field. Pagination is handled internally and will fetch the amount of data you need.
Refresh Settings Period of time before next refresh call is triggered. This will automatically trigger a call for the API configured in the data source to keep the data up to date. If you do not want to sync your new data, choose ‘Never’.
Data Formats By default data is retrieved in JSON format. Additionally XML is supported in Lighthouse.

Setting up the URL

  1. Replace <:domain> with your Lighthouse domain.
  2. Query the /Projects endpoint.
  3. From the listed information get the id of the specific Project.

Replace it in the URL to query a tickets:

https://my-sample-domain.lighthouseapp.com/projects/140556/tickets

Sample queries

Milestones

https://my-sample-domain.lighthouseapp.com/projects/140556/milestones

Messages

https://my-sample-domain.lighthouseapp.com/projects/140556/messages

Preview and data import

  • Click Preview & Connect to connect with the configurations set.

  • The Choose Schema(s) dialog opens. The schema represents the key fields of JSON data retrieved from Lighthouse Rest API request. This dialog displays a list of schemas in treeview and its corresponding values in grid for preview. Select required schema(s) from treeview to use in designer and click Connect.

    Preview

  • Now, the data design view page with selected table schema opens. Drag and drop the table. Query Editor

  • Click Save to save the data source with a relevant name.

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough

Lighthouse Integration