Surveys Objects

Survey User Answer

This object is used to store information about answers responded to Survey questions in the Surveys module.

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

Field Name	Description
Answer Id	Unique Id of a Survey answer from the Survey User Answer object. Id of an each allowed answer.
Answer Rank	Sequence Number of an answer for Ranking question.
Answer Text	To store Comment of an answer.
Participant Id	Unique Id of a Participant from Survey Participant object.
Question Id	Unique Id of a Question from Survey Question object.
Responded Date*	DateTime when an answer was responded.
Survey Id	Unique Id of a Survey from Survey View object.

*In case if the survey is partially responded, Responded Date takes the date of the last time when the survey was partially responded.

Survey Translation

This object is used to store information about the translation of survey data when a survey is multilingual in the Surveys module.

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

Field Name	Description
Answer Id	Unique Id of a Survey answer from Survey User Answer object. Id of an each allowed answer.
Category	Category of a survey that is translated: Static Text/Survey/Question/Library Question/Allowed Answer.
Code	A simple unique identifier of a Static Text.
Language Id	A unique Id of a Language that is created by Admin.
Library Question Id	A unique Id from Library Question object.
Survey Id	A unique Id from Survey View object.
Survey Question Id	A unique Id from Survey Question object.

Survey Question Library

This object is used to store information on reusable questions that can be used in multiple surveys in the Surveys module.

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

Field Name	Description
Active	Flag that indicates whether a library question is Active or not. You can use only use Active questions.
Allow Comment	Flag that indicates whether a library question allows to insert comments or not.
Comment Label	Label of a comment box that displays before you add any comment in the comment box.
Display Order	Display order of the library questions while configuring a survey.
Reporting Label	Label of a library question in Reporting on any flattening object.
Selector	To store different kind of options to select either a single select or multi select items, Ex: Radio/Multi select checkbox/Single Select Checkbox.
Title	To store title of a Library question.
Type	To store the type of a Question: Single select/Multi select/NPS®.
Folder Id	A unique Id of a Folder from Survey Folder object in which a library question is stored.

Survey Page

This object is used to store information about Survey pages in the Surveys module.

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

Field Name	Description
Display Order	Display order of Survey pages.
Title	Stores title of a Survey page.

Survey Question

This object is used to store information on a survey question that is used in a Survey in the Surveys module.

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

Field Name	Description
Active	Flag that indicates whether a question is Active or not. You can use only use Active questions.
Allow Comment (Boolean)	Flag that indicates whether a question allows to insert comments or not.
Comment Label	Label of a comment box that displays before you add any comment in the comment box.
Display Order	Display order of the questions while configuring a survey.
Page Id	A unique Id of a Page where a specific question is used.
Reporting Label	Label of a question in Reporting on any flattening object.
Select to	To store different kind of options to select either a single select or multi select items, Ex: Radio/Multi select checkbox/Single Select Checkbox.
Survey Id	A unique Id from Survey View object.
Title	To store title of a Survey Question.
Type	To store the type of a Question: Single select/Multi select/NPS®.

Survey Folder

This object is used to store information on a Survey folder that is used to store multiple library questions in the Surveys module.

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

Field Name	Description
Name	Name of the Survey Folder that stores few library questions

Survey View

This object is used to store information of each Survey in the Surveys module.

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

Field Name	Description
Allow Internal Submission	(Boolean) Flag that indicates whether a survey allows Internal Submission (internal employee to respond to a Survey on behalf of another user).
Category	To store category of a Survey Anonymous/non-anonymous/partial anonymous.
Code	A simple unique code to identify a survey.
Description	Description to a Survey. Displayed as Header in the Survey Page.
End Date	Survey Expire date (Date by which a participant has to respond to a Survey).
Entity Type	Company/Relationship
Last Response Tracked At	To store DateTime when a Survey has been responded last time.
Link Expiry Days	To store the number of days that a Survey link is active (after which the survey expires).
Name	Name is mandatory. It appears to the end user when you do not assign a Title to a Survey.
NPS® Survey (Boolean)	Flag that indicates whether a Survey is of type NPS®. It is true if a Survey has NPS® question.
Owner Id	A unique Id of owner who created the survey.
Partial Submit Days	The number of days after which a survey that has been partially saved is responded as partially submitted.
Published Date	Date on which the survey is published to send across.
Published URL	Site URL of a Survey.
Question Count	The number of Questions in a Survey.
Relationship Type Id	A unique Id of a Relationship Id.
Start Date	The date by when you can publish a Survey. Unless a Survey is published, you cannot send it across from any distribution channel.
Status	of a Survey: Design/Published/Closed (Expired).
Title	Display Name in UI and it is shown as Survey Title in the end user Response page.
Type	of a Survey: Transactional (A survey that is sent on a specific context)/Non-Transactional.

NPS® Survey Response

This object is used to store information about an NPS® Survey and its Response in the Surveys module.

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

Field Name	Description
Comment	The NPS® comment
Company Id	A unique Id from the Company object that a survey is associated with.
Company Person Id	A unique Id from the Company Person object, details of a participant associated with a Company.
Email	Email Id of the participant which is fetched from Survey Participant object.
Language Id	Details of a language in which an end user has responded.
Name	Participant Name.
NPS® Score	NPS® Score of a Survey.
Participant Id	A unique Id of a Participant fetched from the Survey Participant object.
Person Id	A unique Id from Person object.
Relationship Id	A unique Id from the Relationship object that a Survey is associated with.
Relationship Person Id	A unique Id from the Relationship Person object, details of a participant associated with a Relationship.
Responded Date	The date on which an NPS® Survey is responded.
Score Type	Score type of an NPS® survey: Promoter/Detractor/Passive.
Sentiment	Sentiment is stored from the analytics on the Survey comments.
Survey Id	A unique Id from the Survey view object that helps fetch Survey details.
True NPS®	Stores the value 100 (Promoter) / 0 (Passive) / -100 (Detractor) for the NPS® response. Average the values of this field to compute the True NPS® categorized by Participant / Company attributes.

Survey Allowed Answer

This object is used to store information about the number of answers supported for any Survey (for an NPS® Survey, the number of allowed answers is 11 (0 to 10)) in the Surveys module.

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

Field Name	Description
Answer Score	Score assigned to each answer.
Display Order	The display order of the answers that are displayed in a Survey.
Other Option (Boolean)	Flag that indicates whether a Survey question has other option (true/false).
Survey Id	A unique Id from the Survey view object that helps fetch Survey details.
Survey Question Id	A unique Id from the Survey Question object that helps fetch Survey question details.
Title	The title of the answers.

Survey Text Analytics

This object is used to store information about analytics applied to the Survey comments in the Surveys module.

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

Field Name	Description
Aspect	System dynamically analyses the Survey comments and provides a random Aspect (Ex: If system identifies a word ‘Cockpit’ in the survey comment, the Aspect can be ‘Cockpit’.
Aspect Group	Logical groups of Aspects. Ex. the Aspects “business partner” and “business need” would be grouped together under the "business" Aspect group as this is a logical way of categorizing them together.
Company Id	A unique Id from the Company object that fetches details of a Company.
NPS® Response Id	A unique Id from the NPS® Survey Response object that fetches details about NPS® Survey.
Run Date	The date on which Analytics applied on the Survey comments.
Sentence	It stores each Sentence in a Survey comment.
Sentence Category	It stores either Positive, Negative, or any suggestions that system dynamically categorizes.
Survey Id	A unique Id of a Survey that helps fetch details of a Survey.
Survey User Answer Id	A unique Id from Survey User Answer object that fetches details of a Survey answer from each user.
Participant Id	A unique Id of a participant fetched from Survey Participant object and helps fetch details of a participant.

Survey Participant

This object is used to store details of Survey Participants in the Surveys module.

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

Field Name	Description
AO Participant Id	A unique Id of a participant from AO Participants object if the survey is sent from Journey Orchestrator.
Company Id	A unique Id from the Company object that fetches details of a company, a survey is associated with.
Distribution Channel	A channel from which a survey is distributed: AO (Program)/Email Assist/any anonymous channel.
Email	Email Id of a participant.
External Id	External Id of a participant when the participant details are fetched from.
External Source	External source of Participant when surveys are migrated: It can be either Salesforce or SurveyMonkey.
First Name	The first name of a participant.
Full Name	The full name of a participant.
Internal Question Submission Date	When a survey is responded internally by another person (Ex: CSM) as a survey response to end user’s survey submission. The date on which an internal question is submitted.
Internal Question submitted (Boolean)	Flag that indicates whether an internal question is submitted or not. (true/false)
Internal Question Submitted By	It stores the user details who submitted the internal question. This field fetches details from the User object.
Language Id	A unique Id of Language in which a participant has responded in.
Last Name	The last name of a participant.
Last Response Record Time	A datetime on which a participant has responded to a Survey.
Person Id	A unique Id from Person object that this participant is tied to. This field fetches details from the Person details of this participant.
Relationship Id	A unique Id from Relationship object that this participant is associated with. This field helps fetch details from the Relationship object.
Responded (Boolean)	Flag that indicates whether a participant has responded to a specific Survey or not.
Responded By	User details of a person who has responded to a Survey on behalf of a participant. This field fetches details from the User object through Lookup (internal Submission).
Responded Date	The date on which a participant has responded to a specific Survey.
Response Status	Partially saved/Partially submitted/Submitted.
Survey Id	A unique Id of a Survey from the Survey View object that helps fetches details of a specific Survey.
Survey Opened Date	The date on which a participant has opened a Survey.
Survey Sent Date	The date on which a Survey is distributed to the participants.
Survey Opened (Boolean)	Flag that indicates whether a Survey is opened by a participant or not.
Test Participant (Boolean)	Flag that indicates whether a Survey sent to a participant is Test Participant.
Token	A unique identifier from which a Survey is distributed from.
Response URL	This field helps to view the Survey Response provided by the Survey Participant. Note: This URL will be populated only when a participant responds to a Survey (when submits the Survey Response).

Survey PX Execution Log

This object is used to store details of Survey PX execution log in the Surveys module.

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

Field Name	Description
Created Date	It is of datatype DateTime. It indicates when the record was created.
Deleted	Flag that indicates whether the Survey PX Execution Log is deleted.
Email	It is of datatype Email. Stores the Email address of the user.
Engagement Id	The unique identifier of the engagement.
Error Message	It displays the error message for each failed response.
Event Date	The date on which the Survey PX engagement event was executed.
Event Id	The unique identifier of the Survey PX engagement event.
Event Name	The name of the Survey PX engagement event.
Event Type	The type of the Survey PX engagement event.
Execution Id	The unique identifier for the execution of the Survey PX engagement event.
GSID	GSID of a user record. For example, CSM in a Relationship or Company has a lookup to this record in the User object.
Modified Date	It is of datatype DateTime. Displays the date when the record was last modified.
PX User ID	The unique identifier of a PX user.
Questions Added	The number of Questions added in a Survey.
Questions Failed	The number of Questions failed in a Survey.
Request Id	The unique identifier that helps to probe the Sumologic logs to figure out what has happened as a part of that request.
Retry Count	The number of attempts participant tried to respond to a Survey.
Status	The status of a Survey: Design/Published/Closed (Expired).

Language

This object is used to store details of language in the Surveys module.

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

Field Name	Description
Active	Flag that indicates whether the language is Active or not.
Code	The unique identifier used for the language.
Created By	The user id who created the language.
Created Name	The user name of the person who created the language.
Deleted	Flag that indicates whether the language is deleted.
Display Order	Display order of the questions while configuring a survey
GSID	Unique GSID of the Company/Relationship associated with this language.
ISO Code	The unique identifier for the ISO code.
Modified By	User id who last modified the language.
Modified Date	The date on which the language was last modified.
Name	Used to store the language code.
Source	Source of Participant when surveys are migrated.

Survey Audit Log

This object is used to store details of survey audit logs in the Surveys module.

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

Field Name	Description
Action Type	Action type of a Survey (Transactional/Non-Transactional)
Created By	The user id who created the survey audit log.
Created By Name	The user name of the person who created the survey audit log.
Created Date	The date on which the survey audit was created.
Deleted	Flag that indicates whether the survey audit log is deleted.
Log Id	Unique Id of a person who logged the audit.
Modified By	User id who last modified the audit log.
Modified By Name	The user name who last modified the audit log.
Modified Date	The date on which the audit log was last modified.
Participant Id	Unique Id of a Participant from Survey Participant object.
Person Id	Unique Id from Person object.
Survey Id	Unique Id of a Survey from Survey View object.

CSAT Survey Response MDA Object

This object is used to store information about responses to CSAT Survey questions in the Surveys 2.0 module.

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

Field Name	Description
Comment	The CSAT survey response comment.
Company ID	A unique Id from the Company object that a survey is associated with
Company Person ID	A unique Id from the Company Person object, details of a participant associated with a Company.
Created By	The user id who created the CSAT survey.
Created Date	It is of datatype DateTime. It indicates when the CSAT survey was created.
CSAT Percent	The percentage of CSAT survey.
CSAT Score	CSAT Score of a survey.
Deleted	Flag that indicates whether the CSAT Survey is deleted or not.
Email	Email Id of the participant which is fetched from Survey Participant object.
External ID	External ID of a participant when the participant details are fetched from.
External Source	External source of Participant when surveys are migrated: It can be either Salesforce or SurveyMonkey.
GSID	GSID of a user record. For example, CSM in a Relationship or Company has a lookup to this record in the User object.
Language ID	Details of a language in which an end-user has responded.
Modified By	User id who last modified the survey.
Modified Date	It is of datatype DateTime. Displays the date when the survey was last modified.
Name	The name of the participant.
Participant ID	A unique Id of a Participant fetched from the Survey Participant object.
Person ID	A unique Id from the Person object.
Question ID	Unique Id of a Question from Survey Question object.
Relationship ID	A unique Id from the Relationship object that a Survey is associated with.
Relationship Person ID	A unique Id from the Relationship Person object, details of a participant associated with a Relationship.
Responded Date	The date on which the CSAT Survey is responded.
Survey ID	A unique Id from the Survey view object that helps fetch Survey details.
User Answer ID	A unique Id from the Survey User Answer object.
Role	Role of the Participant while submitting the Survey Response
Score Type	Score type of a CSAT survey, below are possible values: SATISFIED (when CSAT Score is 4 or 5 ) NEUTRAL(when CSAT Score is 3), DISSATISFIED(when CSAT Score is 1 or 2)