Skip to main content

Gainsight CS NXT Data Source

Follow the instructions below to create a new data flow that ingests data from a Gainsight CS NXT source in Nexla.
gainsightcs_api.png

Gainsight CS NXT

Create a New Data Flow​

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

  2. Select the Gainsight CS NXT connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Gainsight CS NXT instance, and click Next; or, create a new Gainsight CS NXT credential for use in this flow.

  3. In Nexla, Gainsight CS NXT data sources can be created using pre-built endpoint templates, which expedite source setup for common Gainsight CS NXT endpoints. Each template is designed specifically for the corresponding Gainsight CS NXT endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Gainsight CS NXT sources can also be configured manually, allowing you to ingest data from Gainsight CS NXT 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 CS NXT endpoints. Each template is designed specifically for the corresponding Gainsight CS NXT 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.

    Get Companies

    Read one or more records that match a specific criteria from the Company object.

    • Enter the query criteria for companies to fetch in the Query for Companies to Fetch field. This should be a JSON object containing the query parameters, including select (array of field names to retrieve), limit (maximum number of records), and offset (pagination offset). The default value includes a sample query with common company fields if not specified.

    • The endpoint uses POST requests to https://{base_url}/v1/data/objects/query/Company with a JSON body containing the query criteria. The endpoint URL is automatically constructed based on your Gainsight CS NXT API base URL from the credential configuration.
    • The endpoint does not use pagination and returns all matching company records in a single request.
    • The endpoint will return all company records matching the specified query criteria. The response data is extracted from the data array in the API response ($.data[*]), with each company record processed individually.

    The query should be a valid JSON object with select, limit, and offset parameters. The select parameter should be an array of field names you want to retrieve from the Company object. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.data[*], which extracts all items from the data array in the API response. For detailed information about querying companies, see the Gainsight CS NXT API documentation.

    Get Custom Objects

    Read one or more records that match a specific criteria of a custom object.

    • Enter the API name of the custom object to fetch in the Custom Object to Fetch field. This should be the API name of the custom object (e.g., CustomObjectName__gc). The default value is CustomObjectName__gc if not specified.

    • Enter the query criteria for custom objects to fetch in the Query for Custom Objects to Fetch field. This should be a JSON object containing the query parameters, including select (array of field names to retrieve), limit (maximum number of records), and offset (pagination offset). The default value includes a sample query if not specified.

    • The endpoint uses POST requests to https://{base_url}/v1/data/objects/query/{object_name} with a JSON body containing the query criteria. The endpoint URL is automatically constructed based on your Gainsight CS NXT API base URL from the credential configuration and the custom object name.
    • The endpoint does not use pagination and returns all matching custom object records in a single request.
    • The endpoint will return all custom object records matching the specified query criteria. The response data is extracted from the data array in the API response ($.data[*]), with each custom object record processed individually.

    Custom object names should be the API name of the custom object (typically ending with __gc). The query should be a valid JSON object with select, limit, and offset parameters. The select parameter should be an array of field names you want to retrieve from the custom object. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.data[*], which extracts all items from the data array in the API response. For detailed information about querying custom objects, see the Gainsight CS NXT API documentation.

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 CS NXT data sources can be manually configured to ingest data from any valid Gainsight CS NXT 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 CS NXT sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Gainsight CS NXT API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Gainsight CS NXT API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Gainsight CS NXT API endpoints typically follow the pattern https://{yourcompany}.gainsightcloud.com/v1/{endpoint_path} where {yourcompany} is your company identifier from the credential configuration.

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. The endpoint requires API Access Key authentication via the Accesskey header, which is handled automatically by your credential configuration. For detailed information about Gainsight CS NXT API endpoints and available APIs, see the Gainsight CS NXT API documentation.