Calling API Callers

Hi everyone, I’m trying to insert an activity to the Timeline and have it be linked to a specific CTA. In my use case, these are onboarding CTAs that are linked to the opportunity through the GS opportunity object, and the users are logging their events automatically from Google Calendar to SFDC. Right now they need to manually log them again in Gainsight if they want the link to the CTA, and the OOTB sync does not link it to the CTA, but I can easily find them with a rule and call the API to post these since I have the link to the CTA through the “Cockpit Associated Records” object. My only problem is that when I call the Timeline API I can only pass “Company” or “Relationship” as a Context Name value. From what I see in the reports, the value should be “CTA” and the Context Id should be the CTA GSID, both of which I have. So is there a way to actually do this or is this an improvement request for the API?

Exciting news, Gainsight Community! We have fantastic news for all Gainsight enthusiasts - introducing the beginner-friendly API Web Based Training! If you're looking to kickstart your Gainsight journey or explore the world of APIs, this is the perfect opportunity for you. Designed with beginners in mind, our API Web Based Training offers a supportive and engaging learning experience. The hands-on exercises, coupled with an easy-to-follow workbook, will guide you step-by-step through the fundamentals of Gainsight's APIs. Get ready to unlock the potential of Gainsight's platform and level up your customer success game! Whether you're new to Gainsight or want to expand your skillset, this course will empower you to integrate Gainsight seamlessly with your current systems.

I am creating a utility which uses the Gainsight APIs to copy CSQLs from Gainsight to Dynamics since we use Dynamics CRM instead of Salesforce. I can use the API to get the CSQLs through (somewhat) documented API calls: POST xyz.us2.gainsightclud.com/v1/data/objects/query/gs_lead → gets me all the CSQLs in the system. However, when I try to update the Gainsight CSQL as to whether the Dynamics Opportunity was Won or Lost (or make any other changes to a Gainsight CSQL) using: PUT xyz.us2.gainsightclud.com/v1/data/objects/query/gs_lead?keys=GSID I am getting the error “Wrong api called, Transactional Data Load not supported for this object. Please check Gainsight Documentation” What is the correct API to use? Or does one exist? Since Gainsight has a Salesforce connector that does the same thing, this must be doable.

Just sharing this instructions in case it's useful for anyone else. This should allow you to export directly from Gainsight to a spreadsheet using the Google Sheets API and external actions. Once you have it set up you can schedule the rules as always and at least you should be able to avoid using the S3 bucket for this type of export. Some considerations: There seems to be an intermittent issue with a call being lost on Gainsight’s side and support is investigating. So TEST IT A LOT! I will update when they find/fix the problem. I’ve tried this exact solution using POSTMAN and it works great. These instructions only show how to configure an Append to a spreadsheet, but you should be able to configure almost anything (like clearing the spreadsheet and exporting all values again, or updating only a specific range of cells) Each external action only allows access to one specific spreadsheet and sheet (for now) You need to have the GSheets API enabled and set up in the Google Cloud Consol

With the August 2024 release, you can associate all types of CTAs to a Success Plan, not just objectives. If you want to do this via rule, it appears you need to use the API for now but it is possible. The Success Plan I tested this with was configured to allow Risk Type CTAs associated with it. While I haven’t tested, I think you probably would need to allow that association for this to work, but I don’t know. So keep that in mind when filtering for what Success Plan types land in your rule query before passing to the API call. My use case also involved creating the CTA with a Linked Object from Salesforce. If you don’t need it, that can be removed. Playbook is also optional I created a Risk Type CTA, so the required fields might vary slightly depending on what type you’re trying to create Here is the JSON I used in a POST request: { "requests": [ { "record": { "referenceId": "1", "Name": "{{CTA_Name_Token}}", "SfdcAccountId": "{{SFDC_Account_Id_Token}}", "OwnerEmail": "{{Owner_Email_

Hey Y’all, Does any have experience in custom pages that updated by external javascript? I am trying to create a release calendar on our community page. I am using a html widget on a custom page. I can hard code the values inside a table in html format, but I’d rather point the code to external service that can automatically be in sync with other applications. Has anyone found a way to do this? Thanks, Anthony

Is anyone else having issues with the Communities REST API, specifically the /external-content/index endpoint, where it’s suddenly returning the error “Could not parse body”?

We are using the latest Gainsight PX REST API · Apiary details and attempting to call all survey results for a particular engagement. The Get Survey Responses appears to show me all of the completed surveys in a six-month window. (I think) Although the [engagementTrackType] only returns a value of ENGAGEMENT_VIEW, but I am assuming that is just a default value and that it does not indicate that this record is just of the views of the survey, as the API call is titled Get Survey Responses . But this call does not return any of the actual response answers from the survey. This is great to count the number of responses, but if i want to connect survey responses to our Customer Service records, I would like the actual response details. Does anyone have any recommendations on how to use the GPX REST API to pull answers to a specific survey? And to add to this challenge, what about when it is a multi-question survey? Any help would be greatly appreciated.

Hello fellow API Callers. I had a great conversation with @link_black today, getting started with the PX API. Postman and ScrollIDs: I am running a User report in Postman and of course hit the 10K limit. What’s the best way to iterate through scroll IDs to get the complete record set in one file using Postman? Python and ScrollIDs: I’ve replicated the Postman query in Python. Has anyone built a nice script to iterate through scroll IDs with Python? Thanks, JC

When using the Read API for the the Custom Object API: Is there a query Body length limit? I reached about 60 fields in my select, plus have a WHERE and ORDER BY clause and fields that return in a shorter query work fine, but when added to the longer query with 60+ fields the queries suddenly fail. When reading from the Activity Timeline object I am not able to read the Notes or the NotesPlainText fields. Is it possible to return a Rich Area Text field such as Notes using the API? Why would the NotesPlainText field, which is a String fail to return? Is there a String length limit for the read API calls?

Hi, I’m trying to figure out the easiest way to ‘find and replace’ certain words/text from playbook tasks and email templates. Our products get renamed from time to time and we need to be able to follow the new brand names when we talk about them to clients in email templates or to CSMs in playbook tasks. It has been a hassle to 1) try to find tasks and emails with specific text in them. Our inventory is in the hundreds. and 2) replace the text in the source. I was hoping an API might be able to do that but none exists for playbooks and email templates. I can update the description in the CTA task via an API but that doesn’t solve the root instance having the outdated text. Curious if others have had similar needs and whether GS is putting this on a roadmap. Thanks, Jasmina

Hello! We want to bring value to Gainsight and develop an extension based on our Signum.AI product that will complement internal customer data with information from external sources (social networks, public news, etc.). Can you advise on the best way to do this? I've seen that Gainsight has its own marketplace for applications, similar to what Hubspot has. However, I haven't fully understood the process of adding our application to this marketplace. Additionally, I noticed there is an API that can be utilized. I would appreciate it if someone could share more information on this case. Thank you.

Hi there - I’m a fairly novice API user but am trying to work my way up to at least - oh - half as competent as @peter_robson and @sdrostgainsightcom. I’ve taken the Gainsight API training and have exchanged emails with the trainer himself (Vivek Gaurav, who is awesome). However, I’m constantly finding myself just sort of throwing up my hands. Postman is a new tool to me, so when I get an “Internal Server Error” when trying to connect my PUT Timeline API Update, one day after it worked just fine, I have no idea how to troubleshoot that. I don’t see anything on Gainsight, nor on Postman’s community, that would help me. I also was lost when it came time to actually update some Timeline activities. The documentation on Gainsight Go is nice, but I feel like it stops short of actually telling me: When you’re in Postman, hover on the three dots, click “Run Collection” and unselect everything except for “PUT Timeline API Update,” then make sure your Excel headers exactly match the API Names o

Hi, I’m looking for ways to chain runs in different GS features. For example, run a program only when a DD has been completed, or run a rule only when the program is completed. We have a use case where a DD is used to create and publish a dataset, and then a program uses the dataset to create participants in a JO, and then a rule complements the program when participants fall off the program that day. If the DD fails to run or expires without us noticing, then the program and rule go out with incorrect data. I have been looking at the events framework but that appears to be mostly suited for external triggers. Has anyone created internal triggers so that one event in Gainsight triggers another? Thanks, Jasmina

Hi, I am a new here and have a question. In the API documentation (https://support.gainsight.com/Gainsight_NXT/API_and_Developer_Docs/Timeline_API/Timeline_APIs) the field ContextName can be “Company” or “Relationship”. But, when a timeline entry is created manually, the context name is set to “SuccessPlan”. Is it possible to add a timeline entry via REST API to a Success Plan? If yes, could you please provide me with a body example? thank you in advance and kind regards, Rachel

Hello, I’m trying to follow the GS API documentation on updating timeline activities. I want to move activities from one account to another. We normally send requests to GS to do it for us. It was suggested somewhere in the community that APIs can handle these updates. Here is my payload and response. The issue is that the activity does not get moved and no error code is provided. Put command and url: https://ourcompany.gainsightcloud.com/v1/ant/es/activity?identifier=gsid Few questions along the way: I tested a zillion times by adding and removing the required fields Subject, Notes, and TypeName, but I do not need to make changes to any of these fields. Are they still mandatory as the documentation says? The gsid below is the activity gsid; the company gsid is where I want to move the activity, and the company name is there because it was there in the examples, but I’m not sure it is required. Is this a required field for the look-up to work? I would like some documentation on how to

Hello group! I’m new to using APIs, and after tinkering with the timeline Post-API, I have a question about the date format. I have my data in a CSV file which I then converted into a JSON file. The date in the payload was sent in the following format "Activity Date": "2020-06-09T00:00:00.000". The activity date however was created as the date/time of the execution command, ie yesterday’s date. Is there anything wrong with my date format? Thank you, Jasmina

Hey everyone. I am trying to create a POST External Action to generate a Milestone (Timeline Activity) on a Relationship after an email is sent through JO. My tests have all failed due to the error: "message": "No records. Aborting!""errorCode": "GS_TL_10_0101" I am including the following fields in the External Action: "referenceId": "1", "ContextId": "1P05A6ERY82MMUAXRAH3L6YS761QA9ROGZVV", "TypeName": "MILESTONE", "GsCompanyId": "{{GsCompanyId}}", "MilestoneType": "{{MilestoneType}}", "RelationshipTypeId": "{{RelationshipTypeId}}", "RelationshipId": "{{RelationshipId}}", "Subject": "{{MilestoneSubject}}", "ActivityDate": "{{RuleDate}}", "Notes": "Test Comment " I tried to update the action to create the Activity on a Company record but received the same error. Please help!

I created a Rule that queries several contact identifiers to calculate an Interaction Count for all active contacts in our system. The Interaction Count will be used to identify the Top Contact at each Account to be used for critical communications via Journey Orchestrator. I have exported the Rule results to Excel to identify the top contact at each account but I am looking to try to automate this process in Gainsight. I am struggling with how to identify the contact with the max Interaction Value for each account in my dataset since the unique contact ID is required for me to define the Top Contact designation to the Person record. Any ideas?

Hi everyone! Thanks @Jef Vanlaer! Recently he asked about this and made me realize I had the same issue 6 months ago and I couldn’t find any documentation or instructions about it. So here it is, short instructions on how to configure your Rules Engine + External Actions to your own Gainsight API. If you see there is any mistake or that we can improve anything, let me know and we can update it. Why do you need this? →There are a lot of use cases where the rules engine does not give the possibility to make changes within you own instance that the API does, so this will give you that extra functionality instead of having an external script running just for that. (e.g: automatically closing Success plans that are completed to 100%, or updating the status of a CTA using GSID to ANY status) Create custom connector to your own GS API Token based below Headers fill out "Accesskey" → <enter your access key here> in GET URL populate with your instance full domain (from https... to the .com) ❗❗❗

Does anyone know how to get more records via the PX API? I am somehow only getting a handful of records when I am requesting all records for a specific user on survey reposnses. Example:{{baseUrl}}/v1/survey/responses?filter=date>01-01-2023&filter=identifyId~639295f8-e365-3c62-8e36-7fcc00f6a4f1 This only gives me 3 responses when I know the user has submitted at least seven. When i try to add a date range, I keep getting a 400 error “exceeded date range190days”.

Is anyone using Hightouch Reverse ETL in their org with their Gainsight instance? Is it only allowed through PX or can CS use it as well? How did you integrate it into your org?

Via this url I found the API call to delete a Person, which works wonderfully. For my use case however, I want to delete Relationship Person or Company Person via API, without deleting the Person (they might still exist on another Company or Relationship). Is there an option to do that?

Hello all - this is Scott Drost at Gainsight, and I run the weekly US Admin Office Hours session. I was also on the floor at PAL back in August, providing tech assistance and generally causing trouble for the presenters (sorry Peter!) Wanting to hear from those who are either using, or interested in using, External Actions to push data FROM Gainsight to OTHER platforms via API. I ask because In my day-to-day work with Gainsight admins, I honestly leverage External Actions almost entirely to update standard objects in Gainsight that the Rules Engine doesn’t allow you to do with an upsert . . . CTAs, for instance, or Success Plans. And yes, it’s a super-handy and viable solution for maintaining those objects, but I’m going to start a separate thread about that. So - If you DO push data to other platforms via External Actions, or if you are in the middle of setting up External Actions push to another platform: What platforms are you pushing to? Who did the heavy lifting on the “target” si

Hello All. I am hoping I am missing something simple here since all other external actions are working fine. I receive the error Code GS_APIG_2401 (Unauthorized) when trying to create or update an Objective or Task using External API. My External Action to create an Objective previously worked but is now returning the error. I confirmed the access key is correct and the required fields are included. Any suggestions?