Operations 4
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I record a customer's business goal with a target date?”
“Can I create a goal from a goal template?”
Tell an agent
Create goal {Name} for company {CompanyId}.
Add a goal {Name} to company {CompanyId} from template {TemplateId}, targeting {TargetDate}.
Ask an LLM
“What is the status of a particular customer goal?”
“Can I fetch one goal by ID?”
Tell an agent
Get goal {goalId}.
Show the details of customer goal {goalId}.
Ask an LLM
“Can I mark a customer goal as achieved?”
“How do I change a goal's target date or owner?”
Tell an agent
Update goal {goalId} to status {Status} (name {Name}, company {CompanyId}).
Move the target date of goal {goalId} to {TargetDate}, keeping name {Name} and company {CompanyId}.
Ask an LLM
“Which customers have open goals due this quarter?”
“Can I filter goals by company or status?”
Tell an agent
Search customer goals where {where}.
Find up to {limit} goals matching {where}.
Documentation
Documentation
https://support.gainsight.com/PX/API_for_Developers
Authentication
https://support.gainsight.com/PX/API_for_Developers/02About/Authentication
Documentation
https://support.gainsight.com/PX/API_for_Developers/APIs_for_Developers/PX_API
Documentation
https://gainsightpx.docs.apiary.io/
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Company_and_Relationship_API/Company_API_Documentation
Authentication
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Generate_REST_API/Generate_REST_API_Key
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Person_API/People_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Custom_Object_API/Gainsight_Custom_Object_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Call_To_Action_(CTA)_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Timeline_API/Timeline_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Success_Plan_APIs/Success_Plan_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Data_Management_APIs/Data_Management_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_REST_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Events_API/Events_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/User_Management_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/SCIM_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/API_for_Company_Team_Record
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Customer_Goals_API/Customer_Goals_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Renewal_Center_API/Renewal_Center_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-goal-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-search-request-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-goal-input-schema.json