|Authentication||Basic HTTP Authentication|
|Sample Query||Always call the API based on the domain of your account. For example
|API Documentation||Lighthouse API documentation|
Creating a data source using Lighthouse
To create a data source using Lighthouse, you need to accomplish the following tasks:
- Start the data source creation process.
- Authenticate with Lighthouse.
- Write a query and enter it in Klipfolio.
- Set up your data source.
Step 1: Start the data source creation process
To create a data source using Lighthouse, go to the Connector Gallery page in Klipfolio and select Lighthouse.
Step 2: Authenticate with Lighthouse
You'll need to authenticate with an API Token from Lighthouse.
To find your Lighthouse API token, you will need to log into your Lighthouse account. Refer to the following instructions by Lighthouse: How do I get an API Token.
Here is a sample API token: e4707bc704cd388fb374d7f55cf75386cfeb3b56
Note: API Token is also referred to as API key.
Step 3: Write the query and enter it in Klipfolio
Refer to the Lighthouse API Documentation to help you write a query. This is what a typical Lighthouse API query looks like in Klipfolio, however, you can also build your own query:
https://<yourSubDomain>.lighthouseapp.com is the endpoint URL and
/projects.json is the API method.
Note: When writing your query, replace '<yourSubDomain>' with a subdomain.
Step 4: Set up your data source
- At URL, enter your Lighthouse domain name, for example
- At Data Format, select JSON (Depending on your query, Lighthouse also provides data in XML format).
- At Method, select GET.
- Select Query Parameters. Under Value, enter your API key.