Skip to main content

Authorization

Follow this guide to create a new Gainsight PX credential that will allow Nexla to authenticate to and exchange data with your Gainsight PX account.
gainsight_px_api_auth.png

Gainsight PX

Prerequisites​

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.

Generate a Gainsight PX REST API Key​

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.

  1. Sign in to your Gainsight PX account at app.aptrinsic.com (or your organization's PX URL).

  2. Navigate to Administration in the left-hand navigation menu.

  3. Select REST API from the administration options. This opens the API Keys management page.

  4. Click the New API Key button to begin creating a new key.

  5. 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.

  6. 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.

  7. 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.

For complete details on API key permissions and management, refer to the Gainsight PX REST API documentation and the Work with the Gainsight PX REST API guide on the Gainsight support portal.

Identify Your Data Residency Region​

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.

Create a Gainsight PX Credential​

  • To create a new Gainsight PX credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Settings​

  1. 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

  2. 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.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. 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.