Gainsight NXT Customer Success

https://support.gainsight.com/gainsight_nxt
Admin
Gainsight NXT Customer Success provides comprehensive documentation and guides for managing customer...
Tokens:780,250
Snippets:11,974
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Fetch Task List Request Examples

Source: https://support.gainsight.com/gainsight_nxt/04Cockpit_and_Playbooks/00Cockpit_Horizon_Experience/Cockpit_API_Documentation/Task_and_Playbook_API_Documentation

Examples of GET requests using pagination parameters and field inclusion.

```text
/v2/cockpit/task/list/<CTA_GSID>?pn=1&ps=500
```

```text
/v2/cockpit/task/list/<CTA_GSID>?includes=DT_Date__gc,DT_DateTime__gc
```

--------------------------------

### Get Playbook Configuration with Filters

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs

Example request URL specifying active status and playbook types.

```text
/v2/cockpit/admin/playbook?active=true&et=COMPANY&type=Risk,Expansion
```

--------------------------------

### Get Describe OMD Sample Request

Source: https://support.gainsight.com/gainsight_nxt/02Data_Management/Data_Management_API_Documentation/Data_Management_APIs

An example request targeting a specific custom object.

```http
http://localhost:8080/v1/meta/services/objects/customobj__gc/describe?ic=true&cl=0&idd=true
```

--------------------------------

### Verify Node.js Installation

Source: https://support.gainsight.com/gainsight_nxt/AI_Assistants/Admin_CLI/Configure_Admin_CLI

Check the installed versions of Node.js and npm.

```bash
node -v
```

```bash
npm -v
```

--------------------------------

### Install Admin CLI Package

Source: https://support.gainsight.com/gainsight_nxt/AI_Assistants/Admin_CLI/Configure_Admin_CLI

Install the latest version of the Admin CLI globally.

```bash
cd ~/Documents/gainsight-admin-cli
npm install -g @gainsight/gs-admin-cli@latest
```

--------------------------------

### Install Node.js via Homebrew

Source: https://support.gainsight.com/gainsight_nxt/AI_Assistants/Admin_CLI/Configure_Admin_CLI

Use Homebrew to install Node.js on your system.

```bash
brew install node
```

--------------------------------

### Verify Admin CLI Installation

Source: https://support.gainsight.com/gainsight_nxt/AI_Assistants/Admin_CLI/Configure_Admin_CLI

Confirm the CLI is correctly installed and accessible.

```bash
gs-admin --help
```

--------------------------------

### Configure Gainsight NXT Visualforce Component

Source: https://support.gainsight.com/gainsight_nxt/Team_View/Admin_Guides/Configure_Gainsight_NXT_Custom_Widgets

Example implementation of the GSNxt Visualforce component with various configuration parameters.

```Visualforce
<JBCXM:GSNxt accountId = "{!Account.Id}"
companyId = "{!companyId__c}"
gsRelationshipId = "{!gsRelationshipId__c}" 
sectionName = "cockpit"
sectionLabel = "CockpitCTA"
showDetailView = "true"
showTimeline = "true"
sectionConfig = "{'cockpit' : {'filters' : [{'lhs' : 'Case', 'rhs' : 18_Digits_Record_ID}]}}"> 
</JBCXM:GSNxt>
```

--------------------------------

### Install Exchange Online Management Module

Source: https://support.gainsight.com/gainsight_nxt/Timeline/02Admin_Guides/AI_Follow-Up_Admin_Guide?mt-draft=true

Installs the required PowerShell module for managing Exchange Online settings.

```powershell
Install-Module -Name ExchangeOnlineManagement -Scope CurrentUser
```

--------------------------------

### Install Microsoft Teams Module

Source: https://support.gainsight.com/gainsight_nxt/Timeline/02Admin_Guides/AI_Follow-Up_Admin_Guide?mt-draft=true

Command to install the required Microsoft Teams module in PowerShell.

```PowerShell
Install-Module -Name MicrosoftTeams -Force -AllowClobber
```

--------------------------------

### Example Base URL

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Copilot_API/Copilot_API_Documentation

A sample base URL for a specific Gainsight environment.

```text
https://integration-demo-xyz.develgs.com:9015
```

--------------------------------

### Example Connection Output

Source: https://support.gainsight.com/gainsight_nxt/AI_Assistants/Admin_CLI/Configure_Admin_CLI

Displays the expected output format after a successful authentication.

```text
Base URL:     https://YOUR_TENANT.gainsightcloud.com
Auth mode:    OAuth PKCE
Client ID:    ...ZYbVJb
Config file:  /*/.gs-admin/config.json
Token:        valid (expires in 3584s)
```

--------------------------------

### GET Picklist Response Body

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Customer_Goals_API/Customer_Goals_APIs

Example response containing picklist data.

```json
{
    "result": true,
    "errorCode": null,
    "errorDesc": null,
    "localizedErrorDesc": null,
    "requestId": "08ae7618-07b4-4657-808d-7d5463a231fb",
    "data": {
        "picklists": [
            {
                "gsid": "1I00GO4Q83RGDEM94YVKZHCWLIHJNZ6NBPWE",
                "name": "Stage xorg validate",
                "color": "#98E7B1",
                "picklistCategory": "GOAL_TYPE"
```

--------------------------------

### Get Playbook Configuration by Entity Type

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs

Example request URL filtering only by entity type.

```text
/v2/cockpit/admin/playbook?et=COMPANY
```
Tokens:
Raw