Cockpit Objects

Cockpit Template

This object is used to define and manage reusable templates for CTAs and Success Plans, enabling standardized execution across teams.

The following table lists the data fields available in this object:

Field Name	Description
Context Id	Identifier that links the template to a specific context such as Success Plans or CTAs.
Created By	The user who created the template.
Created Date	The date on which the template was created.
Deleted	Indicates whether the template is deleted (True or False)
Display Order	The display order of the template in the user interface.
Entity Type	Indicates whether the template is associated with Company or Relationship.
GSID	Unique Gainsight system identifier for the template.
Is Active	Indicates whether the template is active (True or False)
Modified By	The user who last modified the template.
Modified Date	The date on which the template was last modified.
Name	The name of the template.
Parent Id	Identifier that links this template to a parent object, if applicable.
Playbook Id	The ID of the Playbook associated with this template.
Relationship Type	The Relationship Type associated with the template, if applicable.
Template Json	The configuration of the template in JSON format (system use).
Template Type	The type of template, such as CTA or Success Plan.

DA Picklist

The following table lists the data fields available in this object:

Field Name	Description
Access Allow	Indicates whether access to the picklist is allowed (True or False).
Access Ids	The list of user or group IDs with access to the picklist.
Category	The category under which the picklist is grouped.
Color	The display color associated with the picklist value.
Cta Type	The CTA Type associated with the picklist value.
CTA Type Only For SP	Indicates whether the CTA type is only applicable to Success Plans (True or False).
Deleted	Indicates whether the picklist value is deleted (True or False).
Display Order	The order in which the picklist value appears in the UI.
Entity Type	Indicates whether the picklist applies to a Company or Relationship entity.
GSID	Unique Gainsight system identifier for the picklist record.
Is Active	Indicates whether the picklist value is currently active (True or False).
Is For Success Plan	Indicates whether the picklist value is used in Success Plans (True or False).
Is Open	Indicates whether the picklist value is associated with an open state (True or False).
Is Recurring	Indicates whether the picklist value is used for recurring items (True or False).
Name	The name of the picklist value.
Plural Label	The plural label for the picklist, used in UI and reports.
Relationship Type	The Relationship Type associated with the picklist, if applicable.
Reporting Category	The reporting category linked to this picklist value.
SP Type	The Success Plan type associated with the picklist value.
System Defined	Indicates whether the picklist value is system-defined (True or False).
System Name	The internal system name used for the picklist value.

Reporting Category

The following table lists the data fields available in this object:

Field Name	Description
Deleted	Indicates whether the reporting category is deleted (True or False).
Display Order	Specifies the display order of the reporting category in the UI.
GSID	Unique Gainsight system identifier for the reporting category.
Name	The name of the reporting category.
System Name	The internal system name used for the reporting category.
Type	The type of reporting category.
Id	The parent CTA ID from which the reporting category was generated.

Call To Action

This object is used in Cockpit and Call to Action (CTA). For example; Rules or Reports on CTAs and Success Plans (complete or incomplete, overdue, etc).

The following table lists the data fields available in this object:

Field Name	Description
Age	For how long a CTA is open (Closed Date - Created Date) or (Today - Created Date).
Close Source	Indicates how a CTA was closed. For example; Manually, By Rules, etc.
Closed Date	CTA Closed Date.
Closed Date (With Time)	The date and time when the CTA was marked as closed.
Closed Task Count	The number of CS Tasks that are closed in a CTA.
Comments	Additional notes added to the CTA for context or internal updates.
Company	The name of the Company.
Created By	The user who created the CTA.
Created Date	Created date of a CTA.
Created Date In User Timezone	The date and time when the CTA was created, displayed in the user’s timezone.
Days Allocated	The total number of days allocated to complete the CTA from its start date.
Days Due	The number of days due to close a CTA (Original Due Date - Created Date).
Days Past Due Date	The number of days past the due date of a CTA.
Deleted	Indicates whether the CTA is deleted (True or False).
Dependency Meta	This is used to store the Gantt Chart dependencies and is used internally only.
Due Date	Due date of a CTA.
Due Date Variance	Number of days that a CTA due date is changed by (New Due Date - Old Due Date).
Entity Type	Company/Relationship.
Event Properties	This is used to store recurring CTA information.
GSID	Unique system identifier assigned to the CTA by Gainsight.
Is Closed	It indicates whether a CTA is closed.
Is Closed Overdue	Indicates whether the CTA was closed after its due date (True or False).
Is Draft	Indicates whether the CTA is in the draft state (True or False).
Is Important	Indicates whether the CTA is marked as important (True or False).
Is Overdue	Indicates whether the CTA is currently past its due date (True or False).
Is Recurring	Flag that indicates whether a CTA is part of Recurring CTAs (True or False).
Is Snoozed	Indicates whether the CTA is currently snoozed (True or False).
Modified By	The user who last modified the CTA.
Modified Date	The date on which the CTA was last modified.
Name	The name or title of the CTA.
Next Action Due Date	The due date of the next scheduled action within the CTA.
Objective Category	The category assigned to the objective associated with the CTA.
Open Task Count	The number of Tasks currently in an ‘Open’ state in a CTA.
Original Due Date	The original due date of a CTA.
Overdue Type	Overdue/Due in Next 7 Days/Open (Due in more than 7 days).
Owner	The user assigned to the CTA.
Parent Id	The parent CTA Id from which the current CTA is generated. This field is applicable to Recurring Lifecycle CTAs.
Percent Complete	The Percentage of the Tasks closed in a CTA (Closed Task Count/Total Task Count).
Playbook	Name of a Playbook.
Priority	The priority status of a CTA.
Reason	The reason of a CTA.
Relationship	Name of Relationship to which the CTA belongs.
Relationship Type	Name of a Relationship Type to which a CTA type belongs.
Rule Action Id	Rules Action from which a CTA is generated.Note: When a Rule or Action setup is updated, corresponding Rule ID and Action ID are not updated. Value in this field is not changed for a specific CTA record.
Shared With Spaces	Indicates whether the CTA is shared with users in Spaces (True or False).
Sharing Type	Specifies how the CTA is shared, such as Private, Shared, or Public.
Snooze Reason	The reason of snooze for a CTA
Snoozed on	Date on which a CTA is snoozed.
Snoozed until	Date & Time until which a CTA is snoozed.
Source	Source from which a CTA is generated (Manual/Rules/Survey/Activity/Advanced Outreach (Program)/Zendesk). Manual: refers to the CTAs that were created by a User, manually. Rules: refers to the CTAs triggered automatically via business rules based on customer data or time factors. Survey: refers to the CTAs triggered from Surveys. Activity: refers to the CTA's that were created from a Timeline Activity. Advanced Outreach: refers to the CTA's that were triggered from Journey Orchestrator Programs. Zendesk: refers to the CTA's that were triggered from Zendesk.
Start Date	The date on which work on the CTA began, or is scheduled to begin.
Status	The status of a CTA.
Success Criteria	The key outcomes or goals that define successful completion of the CTA.
Success plan	The Success Plan linked to the CTA, if applicable.
Template Display Order	The order in which the CTA appears when created from a template.
Total Task Count	The total number of tasks associated with the CTA.
Type	The type of CTA, such as Risk, Lifecycle, or Expansion, based on the business context.
User Pool Id	Identifier that links the CTA to a user pool for assignment or routing.

CS Task

This object is used in Calls to Action and CS Tasks. For example; Reports on the CS Tasks (complete or incomplete, overdue, etc).

The following table lists the data fields available in this object:

Field Name	Description
Close Source	Indicates how the task was closed, such as manually or through a rule.
Closed Date	Closed date of a CS Task.
Closed Date (With Time)	The exact date and time when the task was closed.
Company	Company Name in Gainsight (GSID).
Created By	The user who created the task.
Created Date	Created date of a CTA Task.
CTA	The parent CTA to which the task belongs.
Days Allocated	The total number of days allocated to complete the task.
Days Due	The number of days assigned to close a CS Task from created date (Original Due Date - Created Date).
Days Past Due Date	The number of days that a CTA Task passed the due date.
Deleted	Indicates whether the task has been deleted (True or False).
Dependency Meta	Stores task dependency information used internally for scheduling and Gantt charts.
Description	Additional details or context about the task.
Display Order	The position of the task in the task list display.
Due Date	The due date of a CTA Task.
Due Date Variance	The number of days that a Task due date is changed by (New Due Date - Old Due Date).
Dynamic Metadata	Stores dynamic task data used internally by the system.
Entity Type	Indicates whether the task is associated with a Company or a Relationship.
Gainsight Task Id	Unique identifier assigned to the task within Gainsight.
GSID	Unique system identifier for the task in Gainsight.
Is Closed	Status of a Task whether it is Closed or not.
Is Closed Overdue	Indicates whether the task was closed after its due date (True or False).
Is Email Sent	Indicates whether email is sent from Cockpit for this task (Email Assist Tasks).
Is Important	Indicates whether the task is marked as important (True or False).
Is Overdue	Indicates whether the task is past its due date (True or False).
Is Synced	Indicates whether the task is synced with an external system (True or False).
Last Update Source	The source from which the task was last updated.
Modified By	The user who last modified the task.
Modified Date	The date on which the task was last modified.
Name	The name or title of the task.
Original Due Date	The original due date of the CTA Task.
OverDue Type	The status of a Task whether it is past the due date.
Owner	The user assigned to the task.
Parent Task	The task on which the current task is dependent on, or is linked to in a sequence.
Playbook	Lookup to the Playbook record from which the task was generated.
Playbook Task	Indicates the Playbook from which the task was generated, if applicable.
Priority	Priority of a Task (Low, Medium, High, and so on).
Relationship	The name of the Relationship associated with the task, if applicable.
Relationship Type	The type of Relationship to which the task belongs.
Source	The source from which the CS task is created. Manual = created by a user, Activity = created from a timeline entry, from Rules, Survey, etc.
Start Date	The date on which the task is scheduled to begin.
Status	Indicates the status of a Task (Open, Closed, and so on).
Sync Status	Indicates the current sync state of the task with external systems.
Timeline Activity Id	This field helps fetch information of an email activity in Timeline that the current CS Task is generated from.
To Email Type	The type (Contact/User/Manual) of To email address used to send email.
Type	The type of a CTA Task.

Playbook

This object is used in Playbooks.

The following table lists the data fields available in this object:

Field Name	Description
Created By	The user who created the Playbook.
Created Date	The date on which the Playbook was created.
CTA Type	The CTA type name.
Deleted	Flag that indicates whether the Playbook is deleted.
Description	The information related to the Playbook.
Entity Type	Account/Relationship.
GSID	Unique Gainsight system identifier for the Playbook.
Is Active	Indicates whether the Playbook is active (True or False).
Is Auto Sync Enable	Flag that indicates whether a playbook is auto synced to SFDC or not.
Modified By	User who last modified the Playbook.
Modified Date	The date on which the Playbook was last modified.
Name	The name of the Playbook.
Relationship Type	Name of a Relationship Type to which Playbook belongs.
Sync Status	The sync status of a Playbook.
Task Count	The total number of tasks defined in this Playbook
Used Count	The total number of CTA in which this Playbook is used.

Cockpit Associated Records

This object is used to get data on SP templates and linked objects. For example; how to build report on SP templates and Linked Objects.

The following table lists the data fields available in this object:

Field Name	Description
Context Data	Stores metadata related to the context in which the record is used.
Created By	The user who created this record.
Created Date	The date on which this record was created.
CTA	The name of the CTA associated with this record.
Deleted	Indicates whether the record has been deleted (True or False).
External Object	The object that is used to store external IDs associated with this record.
External Object Id	The ID of the external object associated with this record.
GSID	Unique Gainsight system identifier for the record.
Linked Object	The name of the object linked to the CTA or Success Plan in this record.
Modified By	User who last modified the record.
Modified Date	The date on which the record was last modified.
Success Plan	The name of the success plan template that is associated with this record.
Task	The name of the task that is associated with this record.