Gainsight PX Data Source
Gainsight PX
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 Gainsight PX connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Gainsight PX instance, and click Next; or, create a new Gainsight PX credential for use in this flow.
-
In Nexla, Gainsight PX data sources can be created using pre-built endpoint templates, which expedite source setup for common Gainsight PX endpoints. Each template is designed specifically for the corresponding Gainsight PX endpoint, making source configuration easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.Gainsight PX sources can also be configured manually, allowing you to ingest data from Gainsight PX 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 Gainsight PX endpoints. Each template is designed specifically for the corresponding Gainsight PX 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
Gainsight PX data sources can be manually configured to ingest data from any valid Gainsight PX 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 Gainsight PX sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom query 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 Gainsight PX API from the Method pulldown menu. The Gainsight PX REST API uses:
- GET: For retrieving data — accounts, users, features, segments, engagements, and events
- POST: For sending data or creating new records
API Endpoint URL
-
Enter the URL of the Gainsight PX API endpoint from which this source will fetch data in the Set API URL field. The base URL depends on your data residency region:
- US:
https://api.aptrinsic.com/v1 - EU:
https://api-eu.aptrinsic.com/v1 - US2:
https://api-us2.aptrinsic.com/v1
Append the specific endpoint path to the base URL. For example, to retrieve all accounts, enter
https://api.aptrinsic.com/v1/accounts. - US:
Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For the full list of available endpoints, refer to the Gainsight PX REST API documentation.
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.
Date/time macros are particularly useful with Gainsight PX event endpoints that accept dateRangeStart and dateRangeEnd query parameters, allowing you to retrieve events for a rolling time window on each 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. 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 useful when you need to create Gainsight PX API endpoints that reference specific IDs — for example, to retrieve events for a specific account ID or user ID obtained from another Nexla source.
-
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 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. Gainsight PX API responses typically wrap data arrays in a named top-level key (for example, accounts, users, events, or responses).
For example, when requesting accounts, the API returns a JSON object with an accounts key containing the array of account records, along with a scrollId for pagination. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.
For most Gainsight PX endpoints, the path to data follows the pattern $.<resource>[*] — for example, $.accounts[*] for accounts, $.users[*] for users, and $.events[*] for event 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.,
$.accounts[*]to access the array of account objects within the response).
Path to Data Example:If the API response includes a top-level array named
eventsthat contains the relevant event records, the path to the response would be entered as$.events[*]. - 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.,
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. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.
For example, Gainsight PX event endpoint responses include a scrollId used for pagination. If you have specified $.events[*] as the path to data but want to include the scrollId or other response-level fields, you can use the metadata path to capture them.
Metadata paths are particularly useful for preserving API response context like request identifiers or summary statistics that apply to all records in the response.
-
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.
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 may be needed for API versioning or custom request parameters.You do not need to include the
X-APTRINSIC-API-KEYauthentication header in this field. This header is added automatically by Nexla based on the API key stored in your Gainsight PX credential.
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 Gainsight PX 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.