Gainsight PX (formerly Aptrinsic) is a product experience platform that lets software companies deliver personalized in-app engagements, track feature adoption, analyze user behavior, and measure customer health. It provides user analytics, guided walkthroughs, NPS and CES surveys, segment-based targeting, and event tracking — helping product and customer success teams understand and improve user engagement.
Power end-to-end data operations for your Gainsight PX API with Nexla. Our bi-directional Gainsight PX connector is purpose-built for Gainsight PX, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Gainsight PX or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Gainsight PX workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
To connect Nexla to Gainsight PX, you need a Gainsight PX account with administrator access and a REST API key. Gainsight PX uses API key authentication — each API key is scoped with specific permissions that control which data can be read or written via the API.
Gainsight PX REST API keys are created and managed from within the PX administration console. Each key can be assigned granular read and/or write permissions across different resource types.
Sign in to your Gainsight PX account at app.aptrinsic.com (or your organization's PX URL).
Navigate to Administration in the left-hand navigation menu.
Select REST API from the administration options. This opens the API Keys management page.
Click the New API Key button to begin creating a new key.
Enter a descriptive name for the key in the Name field (for example, Nexla Integration). Adding a description is recommended so your team can identify the key's purpose.
Under the API Permissions section, select the permissions that Nexla will need:
Read — Required for all data source flows. Allows GET API calls to retrieve accounts, users, features, segments, engagements, and event data.
Write — Required for destination flows. Allows POST and PUT API calls to create or update accounts, users, and custom events.
Select both Read and Write if you plan to use Gainsight PX as both a data source and a destination in Nexla.
Click Create & View to generate the key.
Important
Copy and store the API key value immediately after it is generated. Gainsight PX does not display the key again after you leave the page. Store it in a secure location such as a password manager.
Gainsight PX hosts data in multiple regional data centers. The API base URL used in Nexla must match the region where your PX subscription data resides. The available regions and their corresponding base URLs are:
US — https://api.aptrinsic.com/v1 (default for most US-based accounts)
EU — https://api-eu.aptrinsic.com/v1 (for European data residency)
US2 — https://api-us2.aptrinsic.com/v1 (for accounts on the US2 data center)
The data residency region is set when your Gainsight PX subscription is provisioned. Contact your Gainsight account representative or administrator if you are unsure which region your account uses.
Authenticate using your Gainsight PX API key passed as the X-APTRINSIC-API-KEY request header.
Field
Required
Secret
Description
Data Residency Region
Yes
No
Select your Gainsight PX data residency region. Determines the API base URL used for all requests. Allowed values: US (US data residency region, accessible through API base URL https://api.aptrinsic.com/v1); EU (EU data residency region, accessible through API base URL https://api-eu.aptrinsic.com/v1); US2 (US2 data residency region, accessible through API base URL https://api-us2.aptrinsic.com/v1)
API Key
Yes
Yes
Your Gainsight PX REST API key. Found under Settings > Products > API Keys in the PX app.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Select your Gainsight PX Data Residency Region from the pulldown menu. This determines the API base URL that Nexla will use for all requests to your Gainsight PX account. Choose the region that matches where your PX subscription data is hosted:
US — https://api.aptrinsic.com/v1
EU — https://api-eu.aptrinsic.com/v1
US2 — https://api-us2.aptrinsic.com/v1
Enter your Gainsight PX REST API key in the API Key field. This key authenticates all Nexla API requests to Gainsight PX using the X-APTRINSIC-API-KEY request header. The key must have the appropriate read and/or write permissions for the data operations you intend to perform.
The API key is stored securely and is masked after saving. To rotate or revoke an API key, return to Administration > REST API in Gainsight PX and manage keys from that page.
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Gainsight PX connector tile, 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.
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. 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.
Get Accounts
Retrieves all account records from Gainsight PX, including custom attributes, subscription status, and lifecycle metadata. Use this endpoint to pull your full account roster into Nexla for analysis, enrichment, or syncing to downstream systems.
This endpoint uses cursor-based (scroll) pagination and automatically fetches all pages of account records. No manual pagination configuration is required.
Optionally, configure the Page Size field to control how many account records are retrieved per API call. The default is 100 records per page, and the maximum supported value is 100.
Account records include both standard Gainsight PX fields (such as id, name, propertyKeys, and lastSeenDate) and any custom attributes defined for your PX subscription. For a full list of fields, refer to the Gainsight PX API documentation for Accounts.
Get Account by ID
Retrieves a single Gainsight PX account record by its unique account identifier. Use this endpoint when you need to fetch detailed information for one specific account rather than your full account list.
Enter the unique identifier of the account you want to retrieve in the Account ID field. This is a required field. The Account ID corresponds to the id value returned in account records from the Get Accounts endpoint.
The Account ID is the Gainsight PX internal identifier for the account, which may differ from identifiers used in your CRM or billing system. Use the Get Accounts endpoint to look up Account IDs if needed.
Get Users
Retrieves all user records from Gainsight PX, including profile attributes, account association, and custom properties. Use this endpoint to export your full user roster for analysis, enrichment, or synchronization with other systems.
This endpoint uses cursor-based (scroll) pagination and automatically fetches all pages of user records. No manual pagination configuration is required.
Optionally, configure the Page Size field to control how many user records are retrieved per API call. The default is 100 records per page, and the maximum supported value is 100.
User records include standard Gainsight PX fields such as identifyId, email, firstName, lastName, accountId, and lastSeenDate, as well as any custom user attributes defined in your PX subscription. Refer to the Gainsight PX API documentation for Users for the full field reference.
Get User by ID
Retrieves a single user record from Gainsight PX by their unique user identifier. Use this endpoint when you need to fetch detailed profile information for one specific user.
Enter the unique identifier of the user you want to retrieve in the User ID field. This is a required field. The User ID corresponds to the identifyId value assigned when the user was first identified in Gainsight PX.
Get Features
Retrieves all tracked product features defined in Gainsight PX, including feature metadata and tagging. Use this endpoint to export your feature catalog for analysis or to cross-reference with feature usage event data.
This endpoint uses incremental page-number pagination and automatically fetches all pages of feature records.
Optionally, configure the Page Size field to control how many feature records are retrieved per page. The default is 100, and the maximum is 200 for features.
Feature records include the feature name, ID, tags, selector rules, and creation metadata. This data can be joined with Get Feature Match Events records to analyze which users are interacting with each feature. Refer to the Gainsight PX API documentation for Features for full field details.
Get Segments
Retrieves all user and account segments defined in Gainsight PX, including their filter criteria and membership rules. Use this endpoint to export segment definitions for auditing, documentation, or downstream use in targeting logic.
This endpoint uses incremental page-number pagination and automatically fetches all pages of segment records.
Optionally, configure the Page Size field to control how many segment records are retrieved per page. The default is 100, and the maximum is 100 for segments.
Retrieves all in-app engagement definitions configured in Gainsight PX, including guides, dialogs, sliders, and banners. Use this endpoint to export your engagement catalog for analysis or reporting on in-app program coverage.
This endpoint uses incremental page-number pagination and automatically fetches all pages of engagement records.
Optionally, configure the Page Size field to control how many engagement records are retrieved per page. The default is 100, and the maximum is 100 for engagements.
Engagement records include the engagement name, type, ID, targeting configuration, and status. This data is useful for auditing active engagement programs. For full field details, refer to the Gainsight PX API documentation for Engagements.
Get Pageview Events
Retrieves pageview analytics events from Gainsight PX within a specified date range, enabling user journey and navigation analysis. Use this endpoint to understand which pages or views in your product users are visiting and how frequently.
This endpoint uses cursor-based (scroll) pagination and automatically fetches all pages of event records within the specified date range.
Optionally, configure the Page Size field to control how many event records are retrieved per page. The default is 100, and the maximum is 1000.
Configure the Date Range Start (epoch ms) field to set the beginning of the event retrieval window. This value should be a Unix epoch timestamp in milliseconds. The default is the Nexla macro {now-30}, which resolves to 30 days before the current run time.
Configure the Date Range End (epoch ms) field to set the end of the event retrieval window. The default is the Nexla macro {now}, which resolves to the current run time. Both date fields accept Unix epoch millisecond timestamps.
The default date range macros ({now-30} and {now}) use a daily time unit, so each run will retrieve events from the past 30 days. Adjust these values to narrow or expand the retrieval window based on your use case. Refer to the Gainsight PX REST API documentation for full event field details.
Get Session Events
Retrieves user session analytics events from Gainsight PX, including session duration, browser, and OS metadata. Use this endpoint to analyze session-level engagement patterns, such as how long users stay in your product and what environments they use.
This endpoint uses cursor-based (scroll) pagination and automatically fetches all pages of session event records within the specified date range.
Optionally, configure the Page Size field to control how many session event records are retrieved per page. The default is 100, and the maximum is 1000.
Configure the Date Range Start (epoch ms) and Date Range End (epoch ms) fields to define the session event retrieval window. Both fields accept Unix epoch millisecond timestamps. The defaults are {now-30} (30 days ago) and {now} (current time).
Get Feature Match Events
Retrieves feature usage and match events from Gainsight PX, showing which users interacted with tracked product features and when. Use this endpoint to analyze feature adoption trends and identify which user segments are engaging with specific product capabilities.
This endpoint uses cursor-based (scroll) pagination and automatically retrieves all available feature match event records.
Optionally, configure the Page Size field to control how many feature match event records are retrieved per page. The default is 100, and the maximum is 1000.
Feature match events can be joined with feature metadata from the Get Features endpoint to produce a complete picture of feature adoption by user or account segment. Refer to the Gainsight PX REST API documentation for full event field details.
Get Custom Events
Retrieves custom-tracked events fired by your application code within Gainsight PX, filtered by date range. Use this endpoint to retrieve application-specific behavioral events that your engineering team has instrumented in the product.
This endpoint uses cursor-based (scroll) pagination and automatically fetches all pages of custom event records within the specified date range.
Optionally, configure the Page Size field to control how many custom event records are retrieved per page. The default is 100, and the maximum is 1000.
Configure the Date Range Start (epoch ms) and Date Range End (epoch ms) fields to define the custom event retrieval window. Both fields accept Unix epoch millisecond timestamps. The defaults are {now-30} (30 days ago) and {now} (current time).
Custom events are events your development team has explicitly tracked using the Gainsight PX SDK or REST API. They are distinct from automatically captured events such as pageviews and sessions. For full field details, refer to the Gainsight PX REST API documentation.
Get Engagement Events
Retrieves in-app engagement interaction events from Gainsight PX, including viewed, dismissed, completed, and clicked interactions. Use this endpoint to measure the effectiveness of your in-app guides, dialogs, and banners.
This endpoint uses cursor-based (scroll) pagination and automatically retrieves all available engagement event records.
Optionally, configure the Page Size field to control how many engagement event records are retrieved per page. The default is 100, and the maximum is 1000.
Engagement events can be joined with engagement definitions from the Get Engagements endpoint to produce engagement-level performance reports. For full field details, refer to the Gainsight PX REST API documentation.
Get Email Events
Retrieves email engagement events from Gainsight PX email campaigns, including sent, opened, clicked, and bounced events. Use this endpoint to analyze the performance of email communications sent from Gainsight PX.
This endpoint uses cursor-based (scroll) pagination and automatically retrieves all available email event records.
Optionally, configure the Page Size field to control how many email event records are retrieved per page. The default is 100, and the maximum is 1000.
Email events include delivery and engagement metrics that can be used to evaluate campaign effectiveness and identify users with low email engagement. For full field details, refer to the Gainsight PX REST API documentation.
Get Survey Responses
Retrieves NPS, CES, or custom survey response events and scores collected via Gainsight PX in-app engagement surveys. Use this endpoint to export survey data for analysis, reporting, or integration with customer success workflows.
This endpoint uses cursor-based (scroll) pagination and automatically retrieves all available survey response records.
Optionally, configure the Page Size field to control how many survey response records are retrieved per page. The default is 100, and the maximum is 1000.
Survey responses include the respondent's user ID, account ID, survey score, and any open-text responses. NPS responses include the numeric score and category (promoter, passive, or detractor). For full field details, refer to the Gainsight PX REST API documentation.
Get Form Submit Events
Retrieves form submission events captured through Gainsight PX in-app engagements, including field-level responses. Use this endpoint to export user-submitted form data for analysis or downstream processing.
This endpoint uses cursor-based (scroll) pagination and automatically retrieves all available form submission event records.
Optionally, configure the Page Size field to control how many form submission event records are retrieved per page. The default is 100, and the maximum is 1000.
Get Subscription Detail
Retrieves the current Gainsight PX subscription plan details, including limits and configuration for your account. Use this endpoint to monitor your subscription usage, plan limits, and configuration state.
This endpoint retrieves a single subscription record and does not require any additional configuration parameters.
Subscription detail data includes plan type, usage limits (such as monthly active users and event quotas), and current consumption. For full field details, refer to the Gainsight PX API documentation for Subscription Detail.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Gainsight PX data sources can also be manually configured to ingest data from any valid Gainsight PX API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom query parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
The Gainsight PX REST API 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, https://api.aptrinsic.com/v1/accounts to retrieve all accounts). Gainsight PX API responses wrap data arrays in a named top-level key, so the path to data typically follows the pattern $.<resource>[*] — for example, $.accounts[*] for accounts, $.users[*] for users, and $.events[*] for event endpoints. You do not need to include the X-APTRINSIC-API-KEY authentication header in the request headers field — this header is added automatically by Nexla based on the API key stored in your Gainsight PX credential.
Once all of the relevant settings have been configured, 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.
Click the + icon on the Nexset that will be sent to the Gainsight PX destination, and select the Send to Destination option from the menu. Select the Gainsight PX connector from the list of available destination connectors, then select the credential that will be used to connect to the Gainsight PX account, and click Next; or, create a new Gainsight PX credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Gainsight PX endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
Upsert Account
Creates or updates an account in Gainsight PX based on the identifyId field. Use this endpoint to sync account data from your CRM, billing system, or data warehouse into Gainsight PX to keep account profiles current.
This endpoint uses a POST request to the Gainsight PX Accounts API. If an account with the specified identifyId already exists, its attributes will be updated. If no matching account is found, a new account record will be created.
The request body is automatically populated from the mapped Nexset data. Ensure that the Nexset data includes the required identifyId field that Gainsight PX uses to match or create the account record.
Custom account attributes defined in your Gainsight PX subscription can be included in the payload alongside the standard fields.
The identifyId is the primary key used by Gainsight PX to identify accounts. This value should match the account identifier already in use in your Gainsight PX subscription. For full field requirements and payload format, refer to the Gainsight PX API documentation for Accounts.
Update Account
Updates an existing account in Gainsight PX. The accountId is passed in the request body and supports IDs that contain special characters. Use this endpoint when you need to update attributes for accounts that already exist in Gainsight PX, without creating new records.
This endpoint uses a PUT request to the Gainsight PX Accounts update endpoint. Only accounts that already exist in Gainsight PX will be updated — no new account records are created.
The request body is automatically populated from the mapped Nexset data. Ensure that the Nexset includes the accountId field that identifies the account to be updated in Gainsight PX.
Any account attributes not included in the request body will retain their existing values in Gainsight PX.
Use Update Account when you need strict update-only behavior and want to prevent accidental creation of new account records. For create-or-update behavior, use the Upsert Account endpoint instead. For full API details, refer to the Gainsight PX API documentation for Update Account.
Upsert User
Creates or updates a user in Gainsight PX, matching on identifyId and updating their profile and account association. Use this endpoint to sync user data from your identity system, CRM, or database into Gainsight PX to keep user profiles accurate.
This endpoint uses a POST request to the Gainsight PX Users API. If a user with the specified identifyId already exists, their attributes and account association will be updated. If no matching user is found, a new user record will be created.
The request body is automatically populated from the mapped Nexset data. Include the identifyId field, along with profile fields such as email, firstName, lastName, and accountId as appropriate.
Custom user attributes defined in your Gainsight PX subscription can be included in the payload alongside standard profile fields.
The identifyId is the primary key used by Gainsight PX to identify users. This value should be the same identifier used when the user was first tracked in Gainsight PX (typically the internal user ID from your application). For full field requirements and payload format, refer to the Gainsight PX API documentation for Users.
Update User
Updates an existing user in Gainsight PX. The identifyId is passed in the request body and supports IDs that contain special characters. Use this endpoint when you need to update attributes for users that already exist in Gainsight PX, without creating new records.
This endpoint uses a PUT request to the Gainsight PX Users update endpoint. Only users that already exist in Gainsight PX will be updated — no new user records are created.
The request body is automatically populated from the mapped Nexset data. Ensure that the Nexset includes the identifyId field that identifies the user to be updated in Gainsight PX.
Any user attributes not included in the request body will retain their existing values in Gainsight PX.
Use Update User when you need strict update-only behavior and want to prevent accidental creation of new user records. For create-or-update behavior, use the Upsert User endpoint instead. For full API details, refer to the Gainsight PX API documentation for Update User.
Track Custom Event
Sends a custom event to Gainsight PX to track user actions, product usage, or business milestones from external systems. Use this endpoint to record events that originate outside your product's front end — for example, back-end actions, billing events, or support interactions — and make them available in Gainsight PX analytics and engagement targeting.
This endpoint uses a POST request to the Gainsight PX custom events API. Each record in the Nexset will be sent as a separate custom event payload.
The request body is automatically populated from the mapped Nexset data. Each custom event payload should include the following fields:
identifyId — The unique identifier of the user associated with the event.
accountId — The unique identifier of the account associated with the event (optional but recommended).
eventName — The name of the custom event as registered in Gainsight PX.
date — The timestamp of the event in Unix epoch milliseconds.
attributes — A JSON object of custom properties specific to the event (optional).
Custom events must be registered in your Gainsight PX subscription before they can be tracked via the API. Unregistered event names will be rejected. For full payload requirements and field details, refer to the Gainsight PX REST API documentation.
Gainsight PX destinations can also be manually configured to send data to any valid Gainsight PX API endpoint. Using manual configuration, you can also configure Nexla to automatically send the response received from the Gainsight PX API after each call to a new Nexla webhook data source. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
Gainsight PX accepts data in JSON format. The Gainsight PX REST API 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 resource path to the base URL (for example, https://api.aptrinsic.com/v1/accounts to upsert accounts). Use POST to create or upsert records and events, and PUT to update existing accounts or users. You do not need to include the X-APTRINSIC-API-KEY authentication header in the request headers field — this header is added automatically by Nexla based on the API key stored in your Gainsight PX credential.
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Gainsight PX endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to Gainsight PX until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
