Skip to main content

Gainsight-API

This page contains the setup guide and reference information for the Gainsight-PX-API source connector from Gainsight-PX

Prerequisites

Api key is mandate for this connector to work, It could be generated from the dashboard settings (ref - https://app.aptrinsic.com/settings/api-keys).

Setup guide

Step 1: Set up Gainsight-API connection

  • Generate an API key (Example: 12345)
  • Params (If specific info is needed)
  • Available params
    • api_key: The aptrinsic api_key

Step 2: Set up the Gainsight-APIs connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. On the Set up the source page, enter the name for the Gainsight-API connector and select Gainsight-API from the Source type dropdown.
  4. Enter your api_key.
  5. Enter the params configuration if needed. Supported params are: query, orientation, size, color, locale, collection_id
    video_id, photo_id
  6. Click Set up source.

For Airbyte OSS:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Set the name for your source.
  3. Enter your api_key.
  4. Enter the params configuration if needed. Supported params are: query, orientation, size, color, locale, collection_id
    video_id, photo_id
  5. Click Set up source.

Supported sync modes

The Gainsight-API source connector supports the following sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental SyncNo
Replicate Incremental DeletesNo
SSL connectionYes
NamespacesNo

Supported Streams

  • accounts
  • admin_attributes
  • articles
  • feature
  • kcbot
  • segments
  • user_attributes
  • users

API method example

GET https://api.aptrinsic.com/v1/accounts

Performance considerations

Gainsight-PX-API's API reference has v1 at present. The connector as default uses v1.

IP allow list

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference

Config fields reference

Field
Type
Property name
string
api_key

Changelog

Expand to review
VersionDatePull RequestSubject
0.2.342025-08-2365292Update dependencies
0.2.332025-08-0964786Update dependencies
0.2.322025-08-0264345Update dependencies
0.2.312025-07-2664048Update dependencies
0.2.302025-07-1963599Update dependencies
0.2.292025-07-1262993Update dependencies
0.2.282025-07-0562800Update dependencies
0.2.272025-06-2862365Update dependencies
0.2.262025-06-2161951Update dependencies
0.2.252025-06-1461165Update dependencies
0.2.242025-05-2460390Update dependencies
0.2.232025-05-1060045Update dependencies
0.2.222025-05-0359391Update dependencies
0.2.212025-04-2658859Update dependencies
0.2.202025-04-1958372Update dependencies
0.2.192025-04-1257759Update dependencies
0.2.182025-04-0557217Update dependencies
0.2.172025-03-2956481Update dependencies
0.2.162025-03-2255985Update dependencies
0.2.152025-03-0855337Update dependencies
0.2.142025-03-0154970Update dependencies
0.2.132025-02-2254408Update dependencies
0.2.122025-02-1553719Update dependencies
0.2.112025-02-0853311Update dependencies
0.2.102025-02-0152847Update dependencies
0.2.92025-01-2552362Update dependencies
0.2.82025-01-1851703Update dependencies
0.2.72025-01-1151090Update dependencies
0.2.62024-12-2850511Update dependencies
0.2.52024-12-2150041Update dependencies
0.2.42024-12-1449533Update dependencies
0.2.32024-12-1248195Update dependencies
0.2.22024-10-2947864Update dependencies
0.2.12024-10-2847626Update dependencies
0.2.02024-08-1944414Refactor connector to manifest-only format
0.1.142024-08-1744248Update dependencies
0.1.132024-08-1243902Update dependencies
0.1.122024-08-1043117Update dependencies
0.1.112024-07-2742732Update dependencies
0.1.102024-07-2042182Update dependencies
0.1.92024-07-1341928Update dependencies
0.1.82024-07-1041365Update dependencies
0.1.72024-07-0941075Update dependencies
0.1.62024-07-0640893Update dependencies
0.1.52024-06-2540352Update dependencies
0.1.42024-06-2239988Update dependencies
0.1.32024-06-0438979[autopull] Upgrade base image to v1.2.1
0.1.22024-05-2838669Make connector compatible with Builder
0.1.12024-05-0337593Changed last_records to last_record
0.1.02023-05-1026998Initial PR