Planhat Data Source
Planhat
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 Planhat connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Planhat instance, and click Next; or, create a new Planhat credential for use in this flow.
-
In Nexla, Planhat data sources can be created using pre-built endpoint templates, which expedite source setup for common Planhat endpoints. Each template is designed specifically for the corresponding Planhat endpoint, making source configuration easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.Planhat sources can also be configured manually, allowing you to ingest data from Planhat 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 Planhat endpoints. Each template is designed specifically for the corresponding Planhat 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
Planhat data sources can be manually configured to ingest data from any valid Planhat 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 Planhat sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters beyond what the templates expose.
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 Planhat API from the Method pulldown menu. The most common methods are:
- GET: For retrieving data from the Planhat API (used by all source endpoint templates)
- POST: For sending data to the API or triggering actions
API Endpoint URL
- Enter the URL of the Planhat API endpoint from which this source will fetch data in the Set API URL field. Planhat API endpoints follow the base URL pattern
https://api.planhat.com/followed by the resource path (for example,https://api.planhat.com/companiesorhttps://api.planhat.com/endusers).
For a complete list of available Planhat API endpoints and their URL patterns, see the Planhat API Introduction. Ensure the API endpoint URL is correct and that your credential's Service Account has read access to the corresponding data model.
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.
Macros are particularly useful when querying Planhat endpoints that accept date range parameters, enabling you to create incremental data extracts that only pull records updated since the last sync.
-
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. This format will be applied to the base datetime value of the macro—i.e., the value of
{now}in{now-1}. -
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 can adapt based on existing data.
Lookup-based macros are particularly useful for Planhat endpoints that accept a company ID parameter—you can reference a list of company IDs from a Nexla lookup to iterate over multiple companies dynamically.
-
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. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.
Path to Data
If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response.
Planhat REST API endpoints that return lists of records typically return a top-level JSON array (e.g., $[*]). For endpoints that wrap results in an object, you may need to specify a nested path.
Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records. The pre-built Planhat endpoint templates use $[*] as the default path, which handles the top-level array response format used by most Planhat list endpoints.
-
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 responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g.,
$.data.items[*]to access an array of items within a data object). -
For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g.,
/response/data/itemto access item elements within a data element).
Path to Data Example:For most Planhat list endpoints, the response is a top-level JSON array. In this case, the path to the data should be entered as
$[*]. -
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.
-
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 responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.
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). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.You do not need to include the Authorization header in this field—it is automatically applied by Nexla from the configured credential. The Planhat API uses Bearer token authentication, which Nexla handles automatically.
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 Planhat 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.