Leapsome Data Source
Leapsome
Create a New Data Flow
-
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.
-
Select the Leapsome connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Leapsome instance, and click Next; or, create a new Leapsome credential for use in this flow.
-
In Nexla, Leapsome data sources can be created using pre-built endpoint templates, which expedite source setup for common Leapsome endpoints. Each template is designed specifically for the corresponding Leapsome API endpoint, making source configuration easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.Leapsome sources can also be configured manually, allowing you to ingest data from Leapsome endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this source manually, follow the instructions in Configure Manually.
Configure Using a Template
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Leapsome endpoints. Each template is designed specifically for the corresponding Leapsome API endpoint, making data source setup easy and efficient.
Endpoint Settings
- Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.
Endpoint Testing
Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.
-
To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.
-
If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.
Configure Manually
Leapsome data sources can be manually configured to ingest data from any valid Leapsome API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.
With manual configuration, you can also create more complex Leapsome sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.
API Method
-
To manually configure this source, select the Advanced tab at the top of the configuration screen.
-
Select the API method that will be used for calls to the Leapsome API from the Method pulldown menu. The most common method for Leapsome read operations is:
- GET: For retrieving data from any Leapsome API endpoint.
API Endpoint URL
- Enter the URL of the Leapsome API endpoint from which this source will fetch data in the Set API URL field. All Leapsome Content API endpoints begin with
https://api.leapsome.com/v1/. For example, to fetch users you would enterhttps://api.leapsome.com/v1/users.
The complete list of available Leapsome API endpoints and their parameters is documented in the Leapsome API reference.
Date/Time Macros (API URL)
Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is particularly useful for Leapsome endpoints like List Instant Feedback and List Meetings, which support from and to date parameters.
Macros are particularly useful for Leapsome date-filtered endpoints, allowing you to create incremental data flows that automatically retrieve only new records since the last run.
-
To add a macro, type
{at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.{now}– The current datetime{now-1}– The datetime one time unit before the current datetime{now+1}– The datetime one time unit after the current datetimecustom– Datetime macros can reference any number of time units before or after the current datetime—for example, enter(now-4)to indicate the datetime four time units before the current datetime
-
Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. Leapsome date parameters accept ISO 8601 format (e.g.,
yyyy-MM-dd'T'HH:mm:ss'Z'). -
Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro
{now-1}, whenDayis selected,{now-1}will be converted to the datetime one day before the current datetime.
Lookup-Based Macros (API URL)
Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that adapt based on existing data. For example, you could reference a list of Leapsome cycle IDs from an upstream source to automatically iterate over multiple review cycles.
-
To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.
-
Type
{at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list.
Path to Data
If only a subset of the data returned by the Leapsome API endpoint is needed, you can designate the part of the response that should be included in the Nexset by specifying the path to the relevant data. Leapsome API responses typically wrap records in a top-level data array alongside pagination metadata.
For example, a GET /users response returns a structure like {"data": [...], "nextPageToken": "..."}. By specifying the path $.data[*], you instruct Nexla to treat each element of the data array as a record.
Path to Data is essential for Leapsome endpoints that wrap results in a data array. Without specifying the correct path, Nexla will treat the entire response object (including pagination tokens) as a single record.
-
To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.
- For Leapsome responses in JSON format, enter the JSON path that points to the data array. For most Leapsome list endpoints, this is
$.data[*]. For single-record endpoints (such as Get User or Get Goal), use$to return the entire response object as a single record.
Path to Data Example:For a Leapsome list endpoint (e.g.,
GET /users), enter$.data[*]to extract each user record from the response. For a single-record endpoint (e.g.,GET /users/{'{userId}'}), enter$to return the full response as one record. - For Leapsome responses in JSON format, enter the JSON path that points to the data array. For most Leapsome list endpoints, this is
Autogenerate Path Suggestions
Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.
-
To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.
-
Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.
Metadata
If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. For Leapsome endpoints, this is useful when you want to preserve pagination tokens or response-level context alongside each record.
-
To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.
- For Leapsome JSON responses, enter the JSON path to the metadata object or field.
Request Headers
-
If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g.,
header1:value1,header2:value2).You do not need to include the
Authorizationheader here — Nexla automatically adds the Bearer token from your Leapsome credential to every request.
Endpoint Testing
After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.
-
To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.
-
If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.
Save & Activate the Source
- Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Leapsome data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.