Journey Orchestrator Objects
Journey Orchestrator Objects
Some of the most important Gainsight objects used in the Journey Orchestrator module are described here.
Note: The Gainsight feature 'Advanced Outreaches' or 'AO' is renamed to 'Programs' in the application but the application object and field names for Advanced Outreaches feature will have the term 'Advanced Outreaches' (Ex: 'AO Emails' is an object name but is not renamed to Program Emails).
Email Logs
Email Log contains an aggregated entry for a single recipient email. There will be only one entry in the Email Log for a recipient email irrespective of the number of events that occur for that email.
This object is used in Journey Orchestrator, Advanced Outreaches (Programs), Email Assist. For example; Rules/Reports based on success of email campaigns, number of Email Assist tasks sent, types of error messages being returned by systems, etc.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Associated Field | Field from the associated object. |
| Associated Object | Object name to which an email log is associated. |
| Associated Value | The value stored in associated field from associated object. |
| Batch Name | The name of the Batch. |
| Contact Name or User Name | Recipient of the email - if sent internally, User Name is populated, if sent externally, Contact Name is populated. |
| Event Message | An error message returned by the receiving email system. |
| Opened | Binary value, 1 = the email was opened, 0 = the email was not opened. |
| Open Count | Number of times the email was opened. |
| Template Name | The name of the template. |
| Triggered Date | Date/time at which the email was scheduled to go out. |
| Triggered On | Actual date/time that the email was sent. |
| Use Case |
The options are:
|
| Variant Name | The name of the variant used (Default = no variant or default variant triggered). |
Email Logs V2
Email Log V2 object contains an aggregated entry for a single recipient email as well as for analytics information. This object is used in Journey Orchestrator Programs and Email Assist. The following table lists the data fields available in this object:
The name of the email template version.
| Fields | Description |
| Address Type | This field stores the type of influencer, either within your Organization (any Company Person) or within the Company (any Gainsight User). |
| Bounce Type | The type of an automated message from an email system, either Hard or Soft bounce. |
| Bounced | A bounced email is an automated message from an email system, informing the sender of a previous message that the message has not been delivered. |
| Bounced Date | The date on which the email was bounced. |
| Bounced Reason | The actual reason why the email has bounced. |
| Category Ids | IDs of an opt-out page category. |
| Company Id | Unique GSID of the Company. |
| Company Person Id | A unique Id from the Company Person object, details of a participant associated with a Company. |
| Created Date | The date on which the email logs are created. |
| Email Content Id | A unique identifier of the email. |
| Email Id | Email address of the participants. |
| Email Id in Lower Case | Indicates whether the email address of a sender is in lower case. |
| Email Template Id | A unique identifier of the email template. |
| Email Template Name | The name of the email template. |
| Email Template Version Id | A unique identifier of the email template version. |
| Email Template Version Name | |
| External Company Id | The external Id of a company. |
| External Company Person Id | A unique Id of a person from the external company. |
| External Relationship Id | A unique relationship identifier in an external system. It identifies a relationship uniquely apart from Email and Name. |
| External Relationship Person Id | A unique relationship identifier in a person in an external system. |
| External Relationship Type Id | An external GSID field in the Relationship Type object. |
| External User Id | The unique identifier of the external user. |
| First Opened Date | The date on which the email was first opened. |
| From Email Id | An email id of a sender. |
| From Name | The name of a sender. |
| GSID | A unique GSID. |
| Latest Open Date | The date on which the email was last opened. |
| Link Click Date | The date on which the link was last opened. |
| Link Clicked Count | The total number of clicks used to open the link. |
| Link Clicked JSON | The linked clicked date in JSON format. |
| Modified Date | The date on which the email was last modified. |
| Name | The name of the email recipient. |
| Number of Opens | The total number of opens recorded for the email. |
| Opened | Indicates whether the email was opened or not. |
| Page Id | A unique Id of the page. |
| Parent Recipient Id | The unique Identifier of the parent user. |
| Person Id | A unique Id from a Person object. |
| Person Type | This field helps to join the AO Participants object with either Person object or Person Avatar (User, etc) object. |
| Recipient Id | A unique Id of a person who received the email. |
| Record External Id | A unique company identifier record in an external system. It identifies a company uniquely apart from Email and Name. |
| Record External Name | The name of the external record. |
| Record Id | A unique Id of the record. |
| Rejected | A flag that indicates whether an email is rejected due to an incorrect recipient address. |
| Rejected Date | The date on which an email is rejected by a participant. |
| Relationship Id | GS Relationship Id from Gainsight. |
| Relationship Person Id | A unique identifier of the Relationship person. |
| Relationship Type Id | A unique Relationship Type Id of a participant. |
| Reply-to Email Id | A unique email Id of a reply-to email address. |
| Reply-to Name | The name of the person to whom the email was replied. |
| Request Id | The unique identifier helps to probe the Sumologic logs to figure out what has happened as a part of that request. |
| Sent | Indicates whether the email is sent. |
| Sent Date | The date on which the email was sent. |
| 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. |
| Source Id | This field helps to join the AO Participants object with a specific record in the MDA standard object. This helps to build reports on the AO Participants object and join the selected fields from the MDA standard object. |
| Source Name | Name of the participant source. |
| Spam | Indicates whether the email was spammed. |
| Spam Marked Date | The date on which the email was marked as spammed. |
| Triggered Date | The date on which the email was last triggered. |
| Unsubscribed | A flag that indicates whether an email address is unsubscribed from outreaches/programs. |
| Unsubscribed Date | Date and Time on which an email address is unsubscribed from a program. |
| User Id | A unique Id that helps to fetch user information (User Name, Email, Company Name, etc.) from the Gainsight object User. |
GS Asset Usage Tracking
GS Asset Usage Tracking object contains information around reports and dashboards usage. When a dashboard or report is visited by a user or is created, we create a row in this object with information on who is accessing what asset. This object only has usage of Horizon Analytics. The following table lists the data fields available in this object:
| Field Name | Description |
| API Version | Internal version of assets. |
| Asset Id | This differentiates between assets with the same name created by cloning etc. |
| Asset Name | The name of the asset. |
| Asset Type | The type of asset. |
| Event Count | This is the rolling aggregate of times you have accessed a particular asset in a particular manner (see below). |
| Event Type | How an asset is being accessed. We have basic Create, Run, Update, and Delete along with clone and share. |
| Last Used Timestamp | The date and time on which the asset was last used. |
| Request Source | This informs users about how the asset was accessed during a session. |
| Source Type | The type of source that is based on field values. |
| User Id | A unique Id that helps to fetch user information (User Name, Email, Company Name, etc.) from the Gainsight object User. |
Advanced Outreach (Programs)
This object is used to store important information about Programs. For example; create reports on important parameters of Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Advanced Outreach Id | An unique Program Id. |
| Advanced Outreach Code | A code used for unique identification of Programs in Reporting. |
| Advanced Outreach Model Name | Model name of a Program (NPS® Survey/CSAT Survey/Generic Survey/Email Chain). |
| Advanced Outreach Model Type | Transactional (CSAT)/Non-Transactional (NPS®, Generic, Email Chain, etc.) |
| Advanced Outreach Name | An unique name of a Program. |
| Advanced Outreach Start Date | Published date of a Program. |
| Advanced Outreach Status | Draft (NEW in Reports)/Active (PROCESSING in Reports)/Pause/Scheduled/Stop. |
| Advanced Outreach Type | Customer/Relationship |
| Log Emails To Salesforce | Flag that indicates whether emails sent as part of programs are stored in SFDC. |
| Relationship Type Id | Relationship Type Id associated with a program. This field helps fetch information of a Relationship type from the Gainsight object Relationship Type. |
| Relationship Type Name | The name of the Relationship Type associated with a program. |
| Survey Closed Date | Closed date of the Survey attached to the Program. |
| Survey Name | The name of the Survey sent through Programs. |
AO Participants (Program Participants)
This object is used to store information about the Participants in Programs. For example; to retrieve information about the participants in a Program through Report Builder.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Company Name | Name of a company that a participant is associated with. |
| Advanced Outreach Id | A Unique Program Id. |
| First Name | First name of a Participant. |
| Last Name | Last name of a Participant. |
| Full Name | Full name of a Participant. |
| Context Id | A unique ID that can be configured to tie a participant's response back to a specific activity/service offered. For example, the Context ID could be a support ticket number or a webinar code. |
| Last Email Link Clicked | The last instance of a clicked link displayed in email. |
| Last Email Sent | (DateTime) The last instance of an email sent from a program. |
| Last Email Status | Delivered/Not Delivered to the Participant. |
| Manager First Name | First name of participant’s manager. |
| Manager Last Name | Last name of participant’s manager. |
| Manager Full Name | Full name of participant’s manager. |
| Manager Email Address | Email address of a participant’s manager. |
| Participant State | Indicates the state of a Participant in the journey of a Program: Review/Active/Completed/Drop (by system due to token mismatch, incorrect email address, etc.)/Knocked-off (Manual removal of participants from a Program). |
| Participant Id | Unique Id of a participant. |
| Recipient Email Address | Email address of a Participant. |
| Relationship Contact Name | Name of the Relationship Contact. |
| Relationship Name | Name of a Relationship. |
| Relationship Status | Status of a Relationship. |
| Relationship Type Name | Name of the Relationship type. |
| Sender First Name | First name of the organizer/Administrator who sends a Program. |
| Sender Last Name | Last name of the organizer/Administrator. |
| Sender Full Name | Full name of the organizer/Administrator. |
| Sender Email Address | Email address of the organizer/Administrator. |
| Gainsight Company Id | Gainisght Company Id for which a participant is associated with. |
| Gainisght Contact Id | Gainisght contact Id of a participant. |
| Gainisght User Id | Gainisght user Id of a participant. |
| Survey Page Open Count | The survey page count open of the participant. |
| Survey Page Opened | Flag that indicates whether a specific survey page is opened by the participant. |
| Survey Responded | Flag that indicates whether a specific survey is responded to by the participant. |
| Survey Responded Date | The date on which a specific survey is responded to by the participant. |
| Survey Response Status | Submit/Partial Submit (Responded to a survey but not submitted) of a survey by the participant. |
| Survey Score | NPS® score (0-10) of a survey submitted by the participant. |
| Survey Send Date | The date on which a survey is sent by Program to the participant. |
| Total Email Sent | Total number of emails sent to a participant during a Program journey. |
| Person Type (Who ID) | This field helps to join the AO Participants object with either Person object or Person Avatar (User, etc) object. This helps to build reports on the AO Participant object and join the selected fields from the Person or Person Avatar object. |
| GS Person Id (Who ID) | This field helps to join with a specific record in either Person object or Person Avatar (User, etc) object. This helps to build reports on the AO Participant object and join the selected fields from the Person or Person Avatar object. |
| Source Type (What ID) | This field helps to join the AO Participants object with the Gainsight standard object. This helps to build reports on the AO Participants object and join selected fields from the Gainsight standard object. |
| GS Source Id (What ID) | This field helps to join the AO Participants object with a specific record in the Gainsight standard object. This helps to build reports on the AO Participants object and join the selected fields from the Gainsight standard object. |
AO Emails (Program Emails)
This object is used to store information about emails in Programs. For example; to create a report on the information about emails sent by Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Advanced Outreach Id | A Unique Program Id. |
| Bounce Date | The date on which a specific email is bounced. |
| Bounce Type |
Hard/Soft Bounce type:
|
| Email Clicked | Flag that indicates whether a specific email is clicked by the participant. |
| Email Clicked Date | Date on which a specific email is clicked by the participant. |
| Email Id | Email address of the participants. |
| Email Open Count | The total number of instances a specific email is opened by the original recipient. |
| Email Opened | Flag that indicates whether a specific email is opened. |
| Email Send | Flag that indicates whether a specific email is sent to the participants in a Program or not. If the flag is True then the email is sent successfully to the participant and vice versa. |
| Email Template Id | Id of the email template. |
| Email Template Name | Name of the template. |
| From Address | Sender’s email address. |
| Last Email Opened Date | (DateTime) The last instance of an email opened by a participant. |
| Link Clicked Count | The number of instances that a link shared by an email is clicked by the participants. |
| Page Open Count | The number of instances that a Survey Page is opened by the participants. |
| Participant Id | Unique Id of a participant. |
| Rejected | Flag that indicates whether an email is rejected due to incorrect recipient address. |
| Rejected Date | The date on which an email is rejected by a participant. |
| Spam | Flag that indicates whether an email is marked as spam by a participant. |
| Spam Date | The date on which a participant is marked an email as spam. |
| To Address | Recipient (Participant) email address. |
| Undelivered | Flag that indicates whether an email is not delivered to the participants in a Program. |
| Undelivered Reason | Email delivery failure reason. |
| Unsubscribed | Flag that indicates whether an email address is unsubscribed from outreaches/programs. |
| Unsubscribed Date | (DateTime) Date & Time on which an email address is unsubscribed from a program. |
AO Link Clicked Analytics (Program Analytics)
This object is used in Analytics on Programs. For example; to retrieve the analytics on URLs clicked in the Programs through Report Builder.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Advance Outreach Id | A Unique Program Id. |
| Linkclickedcount | The number of times an individual Link is clicked attached in an email. |
| Url | The URL for which the clicked count is tracked. |
AO Participant Activity Analytics (Program Analytics)
This object is used in Analytics on Programs. For example; to retrieve analytics on Program Participant Activities through Report Builder.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Advance Outreach Id | A Unique Program Id. |
| Current Step Name | where the participant is in the journey of a Program. |
| Distinct Count of Participants | The total number of participants who executed a specific step. |
AO Analytics (Program Analytics)
This object is used in Analytics on Programs. For example; to retrieve analytics on Programs through Report Builder.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Advanced Outreach Id | A Unique Program Id. |
| Advanced Outreach Name | Name of a Program. |
| Open Rate | Ratio of emails opened by the participants to the emails sent in the journey of a program. |
| Survey Clicked Through Rate | Ratio of the number of survey links clicked to the number of Survey links sent through a program. |
| Survey Conversion Rate | Ratio of the number of Surveys submitted to the number of Surveys Opened. |
| Total Active Participants | The total number of participants that are active in a specific Program. |
| Total Email Bounced | In a specific Program. |
| Total Email Opened | In a specific Program. |
| Total Email Send | Emails sent as part of a specific Program. |
| Total Number of Participants | In a specific Program. |
| Total Participant Responded To Survey | The total number of participants who submitted the Survey in a Program. |
| Total Participants Opened Survey Page | The total number of participants who opened the survey page in a Program. |
AO Participant Activity (Program Participant Activity)
This object is used to store activities of the Participants in the Programs. For example; to create reports on tracking the journey of participants.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Advanced Outreach Id | A unique Program Id. |
| Current Step Name | Current step of the participant in the journey of a Program. |
| Participant Id | Unique Id of a participant. |
| Previous Step Name | With respect to the current step of the participant in the journey of a Program. |
AO Participant Source Configuration (Program Participant Source Configuration)
This object is used to store information about the source of participants in a Program. For example; to fetch the Program participant list based on its source of ingestion in the Reports.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Advanced Outreach Id | A unique Program Id. |
| Event Name | Name of the Event used to collect the participants. |
| Participant Operation Type | One-time (Add All Participant in Power list in Reports)/Scheduled (Add All Participant in Power list and any in Future in Reports). Indicates whether all the Participants are added into Powerlist now or it’s scheduled. |
| Participant Source Name | Name of the Power List. |
| Participant Source Type | CSV/Power List/Query Builder/Event. |
AO Predefined Advanced Outreach Model (Program Model)
This object is used to store Model information of a Program. For example; to create model information in the Reports.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Advanced Outreach Model Name | Model Name of a Program (NPS® Survey/CSAT Survey/Generic Survey/Email Chain). |
| Advanced Outreach Model Type | Transactional (CSAT)/Non-Transactional (NPS®, Generic, etc). |
AO CTA (Program CTA)
This object is used in Journey Orchestrator module. For example; stores information about CTAs Triggering from Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Company | Company Name. It fetches Company details through lookup from Company. |
| Action Type | Upsert (Create) or Close CTA. |
| Area Name | The product in which a CTA is triggered, CTA in Standard Edition. |
| CTA Id | Unique GSID of a CTA created or closed. |
| CTA Name | Name of the CTA created or closed. |
| CTA Status | Status of a CTA. |
| Entity Type | Company or Relationship. |
| Is Name Identifier | True/False. While creating CTA, when you click ‘include in identifiers’ checkbox to trigger a CTA with unique identifier, CTA is recorded as True in this field. |
| Relationship Id | GS Relationship Id from Gainsight for Relationship CTAs in Standard Edition. |
| Source Step Id | A unique GSID from AO Participant Activity object to fetch details of a step from which a CTA is triggered from a Program. |
AO CTA Mapping (Program CTA Mapping)
This object is used in Journey Orchestrator module. For example; stores information about CTAs triggered against the respective source Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| GS Advanced Outreach Id | A unique GSID from AO Advance Outreach object to fetch details of a JO Program. |
| GS CTA Id | Unique GSID of a AO CTA record that fetches details of this record. |
| GS Participant Id | A unique GSID from AO Participant object to fetch details of a Participant. |
| Step Id | A unique GSID from AO Participant Activity object to fetch details of a step from which a CTA is triggered from a Program. |
Opt-out Pages
This object is used in Journey Orchestrator module. For example; stores information opt-out pages.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Category Ids | IDs of an opt-out page category. |
| Created At | It is of datatype DateTime. Indicates when the opt-out page was created. |
| Created By | User who created an opt-out page. |
| Deleted | Flag that indicates whether an opt-out page is deleted. |
| Description | Description to an opt-out page. |
| GSID | GSID of a person record. For example: Usage Data ID in the data from Segment integration with Gainsight has a look up to this record in Person object. |
| Language Ids | A unique Is of a Language that is created by Admin. |
| Last Update Date | The date on which it was last updated. |
| Modified By | User who last modified the opt-out page. |
| Name | The name of the opt-out page. |
| Page Type | The type of the opt-out page created by the user. |
Opt-out Emails
This object is used in Journey Orchestrator module. For example; stores information about opt-out emails.
Note: Gainsight recommends users to use Opt-Out Emails instead of Unsubscribed emails.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Category Id | ID of opt-out emails category |
| Company Id | Unique GSID of the Company. |
| Created At | It is of datatype DateTime. Indicates when the opt-out email was created. |
| Created By | User who created an opt-out email. |
| Deleted | Flag that indicates whether an opt-out email is deleted. |
| Email Address | It is of datatype Email. Stores the Email address of the user who opted out. |
| Email Log Id | It displays the Email log ID number for the login attempt by the User. |
| Entity ID | The ID of the associated opt-out email activity. |
| Entity Name | Name of the Event used to collect the participants. |
| Entity Type | Company or Relationship. |
| Full Name | Full name of a Participant. |
| GSID | GSID of a person record. For example: Usage Data ID in the data from Segment integration with Gainsight has a look up to this record in Person object. |
| Language Id | A unique Id of a Language that is created by Admin. |
| Last Updated Date | The date on which it was last updated. |
| Modified By | User who last modified the opt-out email. |
| Page Id | A unique Id of an opt-out page. |
| Person Id | A unique Id from Person object. |
| Person Type | This field helps to join the AO Participants object with either Person object or Person Avatar (User, etc) object. |
| Reason | The reason why the participant opted out. |
| Reason Text | The detailed information on why the participant opted out. |
| Reason Type | The reason type for which the participant opted out. |
Opt-out Categories
This object is used in Journey Orchestrator module. For example; stores information about opt-out categories.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Code | A simple unique identifier of a Static Text. |
| Created At | It is of datatype DateTime. Indicates when the opt-out category is created. |
| Created By | User who created an opt-out category. |
| Deleted | Flag that indicates whether an opt-out category is deleted. |
| Description | Description to an opt-out category. |
| Disabled | Flag that indicates whether an opt-out category is disabled. |
| GSID | GSID of a person record. For example: Usage Data ID in the data from Segment integration with Gainsight has a look up to this record in Person object. |
| Last Update Date | The date on which it was last updated. |
| Modified By | User who last modified the opt-out email. |
| Type | The type of opt-out category created by the user. |
AO Failed Participants
This object is used in Journey Orchestrator module. For example; stores information about failed participants in Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Account Name | Name of an account that a participant is associated with. |
| Advanced Outreach Id | A Unique Program Id. |
| Company Id | Unique GSID of the Company, this Relationship is associated with. |
| Context Attribute Boolean | It is a custom Boolean field used for participant mapping. |
| Context Attribute Date | It is a custom Date field used for participant mapping. |
| Context Attribute Decimal | It is a custom Decimal field used for participant mapping. |
| Context Attribute Email | It is a custom Email field used for participant mapping. |
| Context Attribute Integer | It is a custom Integer field used for participant mapping. |
| Context Attribute String | It is a custom String field used for participant mapping. |
| Context Display Name | Account/Relationship Type to which participant belongs. |
| Context Id | A unique ID that can be configured to tie a participant's response back to a specific activity/service offered. For example, the Context ID could be a support ticket number or a webinar code. |
| Context Name | Account/Relationship Type to which participant belongs. |
| Context Object Source | The context source of the participant. |
| Context Url | The context URL for which the clicked count is tracked. |
| Created At | It is of datatype DateTime. Indicates when the participant failed. |
| Deleted | Flag that indicates whether a participant is deleted. |
| External Id | A unique person identifier in an external system. It identifies a person uniquely apart from Email and Name. |
| Failure Reason | It displays the failure message for each failed participant. |
| Failure Reason Json | The failure reason in Json format. |
| First Name | First name of a Participant. |
| Full Name | Full name of a Participant. |
| GS Advanced Outreach Id | A Unique Program Id. |
| GS Manager User Id | A unique Id of a participant’s GS manager. |
| GS Relationship Id | GS Relationship Id from SFDC for Relationship CTAs in Salesforce Edition. Relationship Id from MDA for Relationship CTAs in Standard Edition. |
| GS Relationship Type Id | A unique GS Relationship Type Id of a participant. |
| GS Source Id | This field helps to join the AO Participants object with a specific record in the MDA standard object. This helps to build reports on the AO Participants object and join the selected fields from the MDA standard object. |
| GS User Id | This field helps to join with a specific record in either Person object or Person Avatar (User, etc) object. This helps to build reports on the AO Participant object and join the selected fields from the Person or Person Avatar object. |
| GSID | GSID of a person record. For example: Usage Data ID in the data from Segment integration which Gainsight has a look up to this record in Person object. |
| Last Name | Last name of a Participant. |
| Last Update Date | The date on which it was last updated. |
| Manager Email Address | Email address of a participant’s manager. |
| Manager First Name | First name of participant’s manager. |
| Manager Full Name | Full name of participant’s manager. |
| Manager Last Name | Last name of participant’s manager. |
| Manager User Id | A unique Id of a participant’s manager. |
| Occurrence Count | The total number of instances that the participant occurred. |
| Participant Created By | The participant who entered the program. |
| Participant Json | The participant Json code. |
| Participant Source Name | Name of the participant source. |
| Participant Source Type | CSV/Power List/Query Builder/Event. |
| Person Id | This field helps to join with a specific record in either Person object or Person Avatar (User, etc) object. This helps to build reports on the AO Participant object and join the selected fields from the Person or Person Avatar object. |
| Person Type | This field helps to join the AO Participants object with either Person object or Person Avatar (User, etc) object. This helps to build reports on the AO Participant object and join the selected fields from the Person or Person Avatar object. |
| Recipient Email Address | Email address of a Participant. |
| Relationship Contact Id | A unique identifier of the Relationship Contact. |
| Relationship Contact Name | Name of the Relationship Contact. |
| Relationship Name | Name of a Relationship. |
| Relationship Person Id | A unique identifier of the Relationship person. |
| Relationship Status | Status of a Relationship. |
| Relationship Type Name | Name of the Relationship type. |
| Sender Email Address | Email address of the organizer/Administrator. |
| Sender First Name | First name of the organizer/Administrator who sends a Program. |
| Sender Full Name | Full name of the organizer/Administrator. |
| Sender Last Name | Last name of the organizer/Administrator. |
| SFDC Account Id | SFDC Account Id for which a participant is associated with. |
| SFDC Contact Id | SFDC contact Id of a participant. |
| SFDC Relationship Id | SFDC Relationship Id of a participant. |
| SFDC Relationship Type Id | SFDC Relationship Type Id of a participant. |
| SFDC User Id | SFDC user Id of a participant. |
| Source Type | This field helps to join the AO Participants object with the MDA standard object. This helps to build reports on the AO Participants object and join selected fields from the MDA standard object. |
| Unique Criteria | An unique criteria defined for the participant. |
AO Engagement Mapping
This object is used in Journey Orchestrator module. For example; stores information about engagement mapping in Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Completed Date | The date on which the triggered engagement completed. |
| Created At | The date on which the engagement was triggered. |
| Deleted | Flag that indicates whether the engagement is deleted. |
| Engagement Event Type | The type of PX engagement event. |
| Engagement Id | The unique identifier of the engagement. |
| Engagement Name | The name of the engagement. |
| Engagement Type | Type of engagement triggered. |
| GS Advanced Outreach Id | A unique GSID from AO Advance Outreach object to fetch details of a JO Program. |
| GS Participant Id | A unique GSID from AO Participant object to fetch details of a Participant. |
| GSID | GSID of a person record. For example: Usage Data ID in the data from Segment integration which Gainsight has a look up to this record in Person object. |
| Last View Date | The date on which the triggered engagement was last viewed. |
| Modified At | The date on which the triggered engagement was last modified. |
| Parent Event Id | The unique identifier of the parent engagement event. |
| Parent External Id | The unique identifier of the external user. |
| PX User Id | The unique identifier of a PX user. |
| Status | The status of an engagement. |
| Step Id | A unique GSID from AO Participant Activity object to fetch details of a step from which a CTA is triggered from a Program. |
| Triggered Date | The date on which the engagement is triggered. |
| Viewed Count | The total number of views for the triggered engagement. |
| Viewed Date | The date on which the engagement was viewed. |
AO CTA Events
This object is used in Journey Orchestrator module. For example; stores information about CTA Events in Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Created At | It is of datatype DateTime. Indicates when the record was created. |
| CTA Id | Unique GSID of a CTA created or closed. |
| Deleted | Flag that indicates whether the event is deleted. |
| Event Name | Name of the Event used to collect the participants. |
| Event Time | The time at which this event occurred. |
| Event Type | Company or Relationship. |
| GSID | GSID of a person record. For example: Usage Data ID in the data from Segment integration with Gainsight has a look up to this record in Person object. |
| Modified At | It is of datatype DateTime. Indicates when the record was modified. |
Email Raw Events
Email Raw Events contains records of all the events of a recipient's email such as Sent, Opened, Bounced, Link clicked. The number of records present in the email raw events of a single email is equal to the number of events that occur for that email.
This object is used in the Journey Orchestrator module.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Account ID | Account Id associated with a participant. |
| Address Type | This field stores the type of Influencer, either Within your Organisation (any Company Person) or Within Company (any Gainsight User). |
| Batch Id | The unique identifier of the Batch. |
| Batch Name | The name of the Batch. |
| Clicked Url | The URL for which the clicked count is tracked. |
| Company Id | Unique GSID of the Company, this Relationship is associated with. |
| Company Name | The name of the company. |
| Contact Id | Contact Id of a participant. |
| Created Date | It is of datatype DateTime. Indicates when the record was created. |
| Email Address | It is of datatype Email. Stores the Email address of the user. |
| Email Log Id | The unique identifier for the email log. |
| Event | Name of the Event used to collect the participants. |
| Event Date | The date on which this event occurred. |
| Event Message | An error message returned by the receiving email system. |
| External Email Id | It is of datatype Email. Stores the external Email address of the user. |
| GS Relationship Id | GS Relationship Id from SFDC for Relationship CTAs in Salesforce Edition. Relationship Id from MDA for Relationship CTAs in Standard Edition. |
| IP Address | It displays the Source IP address of the computer used by the User. |
| Metadata | A set of data that describes and gives information about other data. |
| Parent GSID | Parent GSID of a person record. For example: Usage Data ID in the data from Segment integration with Gainsight has a look up to this record in Person object. |
| Parent Name | The name of the parent company. |
| Template Id | Id of the email template. |
| Template Name | The name of the template. |
| Use Case | Cockpit = email was sent via Email Assist task, Program = email was sent via Program, and External sharing = sharing a feature. |
| Variant Id | If of the variant. |
| Variant Name | The name of the variant used (Default = no variant or default variant triggered) |
GS Error logs
This object is used in Journey Orchestrator module. For example; stores information about Gainsight error logs in Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Area Name | The product in which a CTA is triggered, CTA in NXT Edition. |
| Created Date | It is of datatype DateTime. Indicates when the record was created. |
| Entity ID | The ID of the associated Activity entity. |
| Entity Type | Company or Relationship. |
| Error Count | Number of times the sync failed |
| Exception Type | This field is always set to ACTIVITY_SFDC_SYNC_FAILED. |
| Last Modified Date | The Date time when the sync last failed. |
| Message | The actual failure message. |
| Name | The Name or Subject of the Activity. |
Unsubscribed Emails
This object is used in Journey Orchestrator module. For example; stores information about unsubscribed emails.
Note: Gainsight recommends users to use Opt-Out Emails instead of Unsubscribed emails.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Account ID | Account Id associated with a participant. |
| Account Name | Name of an account associated with a participant. |
| Category | Category of an Activity. |
| Contact ID | Contact Id of a participant. |
| Contact Name | Name of the participant contact. |
| Created Date | It is of datatype DateTime. Indicates when the record was created. |
| Email Address | It is of datatype Email. Stores the Email address of the participant. |
| Reason | The reason why the participant was unsubscribed. |
| Reason Text | The detailed information on why the participant was unsubscribed. |
Anonymous Person
This object is used in Journey Orchestrator module.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Created Date | It indicates when the record was created. |
| Dynamic Resolution Key | It is used by Gainsight for internal Master Data Management (MDM) process, not to store any person data for customer usage. |
| Email address of the person. | |
| External ID | A unique person identifier in an external system. It identifies a person uniquely apart from Email and Name. |
| First Name | First name of the person |
| GS Created By | Indicates who has created the record. This field has lookup to the GSID field of the User object. |
| GS Modified By | Indicates who has last modified the record. This field has lookup to the GSID field of the User object. |
| GSID | GSID of an anonymous person record. For example: Usage Data ID in the data from Segment integration with Gainsight has a look up to this record in Person object. |
| Last Name | Last name of the person. |
| Master Avatar Type Code | It is used by Gainsight for internal MDM process, not to store any anonymous person data for customer usage. |
| Master Record ID | It is used by Gainsight for internal MDM process, not to store any anonymous person data for customer usage. |
| Modified Date | It displays the date when the record was last modified. |
| Name | Name of the anonymous person. |
Program External API Logs
This object is used in Journey Orchestrator module. For example; stores information about external API logs in Programs.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Config Id | The unique identifier of an external API configuration. |
| Config Name | The name of the external API configuration. |
| Created At | The date on which the external API configuration was created. |
| Deleted | Flag that indicates the external API configuration deleted. |
| Execution Date | The date on which the external API configuration was executed. |
| Execution Id | The unique identifier of the external API configuration execution. |
| Failure Reason | The external API configuration execution failure reason. |
| GS Advanced Outreach Id | A unique GSID from AO Advance Outreach object to fetch details of a JO Program. |
| GS Participant Id | A unique GSID from AO Participant object to fetch details of a Participant. |
| GSID | GSID of a person record. For example: Usage Data ID in the data from Segment integration with Gainsight has a look up to this record in Person object. |
| Last Response Date | A datetime when a participant has responded to a program. |
| Modified At | The date when the external API configuration was modified. |
| Response S3 Id | The unique identifier of the S3 response. |
| Status | Indicates the status of the executed external API configuration. |
| Status Code | The code that identifies the status of the executed external API configuration. |
| Step Id | A unique GSID from AO Participant Activity object to fetch details of a step from which a CTA is triggered from a Program. |
| Type | The type of the external API configuration. |
AO Failed Participants History
This object is used in Journey Orchestrator module. For example; stores information about failed participants history.
The following table lists the data fields available in this object:
| Field Name | Description |
|---|---|
| Created At | It is of datatype DateTime. Indicates when the record was created. |
| Failure Reason | The detailed reason why the Email was not delivered. |
| GS Failed Participant Id | A unique GSID from AO Participant object to fetch details of a failed Participant. |
| Participant Source Name | Name of the participant source. |
| Participant Source Type | The type of source. CSV/Query Builder/Event. |