Gainsight REST API

Create new customers or updates existing customer info records.

customer object schema :

{
    "data": {
        "customers": [ // array of customer info objects
            {
                "account": "001F000001NH5isIAD", //account ID
                "asv": 1000,
                "mrr": 1200,
                "otr": 1000, //One-time revenue
                "orgContractDate": "2015-02-04", // Orginal Contract Date
                "nextRenewalDate": "2016-02-03" // Next Renewal Date
                "status": "Inactive", // status picklist value
                "stage": "Seasoned Customer", // stage picklist value
                "users": 1200,
                "obj": { // To set any custom fields values
                    "attributes": {
                        "type": "JBCXM__CustomerInfo__c"
                    },
                    "Id": "a0DF000000JLkyRMAT",
                    "jbcxm__nps__c": 3
                }
            }
        ]
    }
}

Note:

• If customer exists with same account ID as sent in request then existing customer info record will get updated, otherwise new customer info record will be created.

schema:

{
    "data" {

        "honorOrgTimeZone": true, //date field values are stored in organization timezone , defaults to false
        "ctas": [ // array of  CTA records
            {
                "account": "account ID",
                "name": "Name of the CTA ",
                "type": "Risk/Opportunity",
                "reason": "CTA Reason",
                "priority": "Priority Type",
                "stage": "Stage Type",
                "assignee": "user ID",
                "playbook": "play book ID",
                "comment": "comment goes here",
                "numOfDays": "3",
                "source": "foo",
                "createdDate": "2015-02-01",
                "dueDate": "2015-02-10",
                "postFrequency": "Never",
                "obj": { // to set any custom field values
                    "attributes": {
                        "type": "JBCXM__CTA__c"
                    },
                    "JBCXM__TaskCount__c": 3
                }
            }

        ]
    }
}

Note:

• Required fields: account, name ,reason and priority.

• if playbook is provided in the request then it will associate the tasks of playbook to the CTA.

• If createdDate is not provided then it will be defaulted to date.today().

• If dueDate is not provided then it will be defaulted to createdDate + 5(excluding weekends).

• If assignee is not provided then it will be defaulted to current session user ID.

• JBCXM__OriginalDueDate__c is always defaulted to dueDate.

schema:

{
    "data": {
        "honorOrgTimeZone": true, //date field values are stored in organization timezone , defaults to false
        "customerFeatures": [{
            "account": "account ID",
            "feature": "Feature Name",
            "comment": "comments goes here",
            "licenced": false, // boolean
            "enabled": true // boolean
        }]
    }
}

Note:

• If record already exits for given feature and account ID then existing record will be updated.

schema:

{
    "data": {
        "honorOrgTimeZone": true, //date field values are stored in organization timezone , defaults to false
        "milestones": [{
            "account": "001i000001DPhyhAAD", //account ID
            "milestoneDate": "2015-02-02",
            "comment": " text goes here",
            "milestone": "Conference" // milestone name
        }]
    }
}

Note:

• If record already exits for given milestone and account ID then existing record will be updated.

schema:

"data": {
    "honorOrgTimeZone": true, //date field values are stored in organization timezone , defaults to false
    "npsResponses": [ // array of  NPS response records
        {
            "account": "SF account id" //Mandatory,
            "userrole": "CSM" //Optional, default value is "User",
            "username": "foo" // Optional, if not passed defaulted to "useremail",
            "useremail": "foo@acme.com" //Mandatory,
            "surveycode": "NPS survey master code",
            "surveyid": "NPS survey master id",
            "npsscore": 5 //It should be in the range of [0, 10] and Mandatory,
                "respondeddate": "2014-02-01"
            "npscomment": "comment goes here" //Optional
        }
    ]
}
}

Note:

• Required fields account, surveycode or surveyid, useremail,npsscore and respondeddate

• If surveycode is provided then it will check if there exists NPS survey master matching with this survey code and associate the record with that survey, otherwise it will create a new NPS master and associate the record with new one.

Set scores for individual measures by account.

schema:

{  "data": {
    "scores": [ // array of scorecard objects
      {
        "account":"account ID",
        "metric":"Customer Relationship", //metric name
        "scorevalue":100, // score value
        "resetscore":true, // if true metric value changed to N/A
        "comment":"comments goes here"
    }
    ]
}
}

Note:

• You should use score or scorevalue to set the score for a metric.

• If record already exits for given measure and account ID then existing record will be updated.

• If customer roll-up summary is enabled then customer level scores are re-populated based on latest scores.

Set scores at customer level (Overall score).

schema:

{
    "data": {
        "scores": [ // array of scorecard objects
            {
                "account": "account ID",
                "scorevalue": 100, // score value
                "resetscore": true, // if true metric value changed to N/A
                "comment": "comments text goes here",
                "goals": "Goals text goes here"
            }
        ]
    }
}

Note: You should use score or scorevalue to set the score for customer overall health.

API call to distribute survey emails once the participants are added to the survey.

schema:

{
    "data": {
        "distributionData": [ // array of  NPS response records
            {
                "surveyCode": "Survey CODE",
                "resend": true, // optional , flag to say resending email to participants. Defaulted to false
                "fromAddress": "From address to use for Gainsight email service", // optional , defaulted to survey level setting
                "emailService": "Gainsight", //Optional, defaulted survey level setting
                "templateId": "Email template to use", //Optional, defaulted survey level setting
                "participants": [ // array of survey participant objects
                    {
                        "attributes": {
                            "type": "JBCXM__SurveyParticipant__c"
                        },
                        "Id": "a0qF0000008WeO0IAK"
                    }, {
                        "attributes": {
                            "type": "JBCXM__SurveyParticipant__c"
                        },
                        "Id": "a0qF0000008WeO0IHJ"
                    }
                ]
            }
        }
    ]
}
}

Load usage data by instance, account and user level.

Usage Object schema:

{
    "data": {
        "usageLevel": "ACCOUNTLEVEL" // supported INSTANCELEVEL ,USERLEVEL and ACCOUNTLEVEL
        "honorOrgTimeZone": true, //date field values are stored in organization timezone , defaults to false
        "usage": [ // array of  usage data records
            {
                account: "account ID ",
                usageLevel: "INSTANCELEVEL/USERLEVEL/ACCOUNTLEVEL",
                instanceId: "foo ",
                instanceName: "Name of the instance",
                user: "user identifier",
                usageDate: "2015-02-04",
                obj: { // if you want to set any custom fields
                    "attributes": {
                        "type": "JBCXM__UsageData__c"
                    },
                    "JBCXM__UniqueVisits__c": 3
                }
            }
        ]
    }
}

Note:

• Required fields based on the Usage level.
  • ACCOUNTLEVEL:account and date(If multiple records are sent with same Account ID and time period then latest record will be considered for updation or creation.)
  • INSTANCELEVEL:account, date and instanceId(If multiple records are sent with same Account ID,Instance ID and time period then latest record will be considered for updation or creation.)
  • USERLEVEL: account, date and user(If multiple records are sent with same Account ID,User ID and time period then latest record will be considered for updation or creation.)