Salesforce Docs Portal

SurveyMonkey Connector Objects

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

Name Description
CollectorMessages Shows information regarding messages sent from a collector.
CollectorRecipients Shows information regarding recipients of all or specific messages sent from a collector.
Collectors Shows collector information.
CollectorStats Shows statistics regarding all or specific messages sent from a collector.
ContactLists Shows contact list information.
Contacts Shows contact information.
Pages Shows information regarding pages for a survey.
RollupQuestions Shows rolled up individual stats information for a survey.
Rollups Shows rolled up stats information for a survey.
SurveyQuestions Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.
SurveyResponses Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.
Surveys Shows information regarding surveys.

CollectorMessages

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the message.
CollectorId String False Collectors.Id No The Id of the collector this message belongs to.
Status String False No The status of this message.
Type String False No Message type: 'invite', 'reminder', or 'thank_you'.
Subject String False No The subject of this message. Only available if resource is being queried by Id.
Body String False No The html body of this message. Only available if resource is being queried by Id.
DateCreated Datetime False No Date message was created. Only available if resource is being queried by Id.
ScheduledDate Datetime False No Date message is scheduled to be sent. If Null, message has not been scheduled to send. Only available if resource is being queried by Id.
EmbedFirstQuestion Boolean False No Whether to embed the first question to the message. Only available if resource is being queried by Id.
EditMessageLink String False No The link to the resource to edit this message. Only available if resource is being queried by Id.
IsBrandingEnabled Boolean False No Whether branding is enabled for this message. Only available if resource is being queried by Id.
IsScheduled Boolean False No Whether this message is scheduled. Only available if resource is being queried by Id.
RecipientStatus String False No Recipient filter: 'reminder' or 'thank_you'. Only available if resource is being queried by Id.

Return to Top

CollectorRecipients

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the recipient.
CollectorId String False Collectors.Id No The Id of the collector this recipient belongs to.
MessageId String False CollectorMessages.Id No The Id of the message this recipient belongs to. Null if it doesn't belong to a specific message.
Email String False No Email of recipient added to collector.
SurveyResponseStatus String False No If the recipient has completed the survey: 'not_responded', 'partially_responded', 'completely_responded'.
MailStatus String False No If an invite message to the recipient has been: 'sent', 'not_sent', or is 'processing'.
SurveyLink String False No Link to the survey in the invite.
RemoveLink String False No Unsubscribe link.

Return to Top

Collectors

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the collector.
SurveyId String False No The Id of the Survey this collector belongs to. Only shows up if filtering Collectors by SurveyId.
Name String False No The name of the collector.
Status String False No Collector status: 'open' or 'closed'. Only available if resource is being queried by Id.
Type String False No Collector type: 'weblink' or 'email'. Only available if resource is being queried by Id.
ThankYouMessage String False No Message for thank you page. Only available if resource is being queried by Id.
DisqualificationMessage String False No Message for disqualification page. Only available if resource is being queried by Id.
ClosedPageMessage String False No Message shown when someone visits a closed survey. Only available if resource is being queried by Id.
DisplaySurveyResults Boolean False No Shows respondents survey instant results when they complete the survey. Only available if resource is being queried by Id.
EditResponseTypes String False No When respondents can edit their response: 'until_complete', 'never', or 'always'. Only available if resource is being queried by Id.
AnonymousType String False No Turns off IP tracking. For email collectors, also removes respondent email address and name from response: 'not_anonymous', 'partially_anonymous', 'fully_anonymous'. Only available if resource is being queried by Id.
SenderEmail String False No Sender email for email collectors. User's email is used if null. Only available if resource is being queried by Id.
Url String False No If collector is a Web Collector (type 'weblink') then the url for the collector. Only available if resource is being queried by Id.
RedirectType String False No Determines survey end page behavior: url (redirects to URL set in redirect_url or if none is set, shows standard SurveyMonkey thank you page), close (closes the survey window or tab), or loop (loops the survey back to the beginning, only available for weblink collectors with allow_multiple_responses:true). Only available if resource is being queried by Id.
RedirectUrl String False No Redirects respondent to this url upon survey completion. Only available if resource is being queried by Id.
AllowMultipleResponses Boolean False No Allows respondents to take a survey more than once from the same browser on the same computer. Only available for weblink collectors. Only available if resource is being queried by Id.
PasswordEnabled Boolean False No True if the collector is password protected. Only available for weblink collectors. Only available if resource is being queried by Id.
DateModified Datetime False No Date collector was last modified. Only available if resource is being queried by Id.
DateCreated Datetime False No Date collector was created. Only available if resource is being queried by Id.
CloseDate Datetime False No Close date of collector. Only available if resource is being queried by Id.

Return to Top

CollectorStats

Name Type ReadOnly References FilterOnly Description
CollectorId String False Collectors.Id No The Id of the collector these statistics belongs to.
MessageId String False CollectorMessages.Id No The Id of the message these statistics belong to. Null if they don't belong to a specific message.
Recipients Integer False No Count of recipients included in the stats.
CompletelyResponded Integer False No Count of recipients who have completed a survey response.
NotResponded Integer False No Count of recipients who have not started the survey.
PartiallyResponded Integer False No Count of recipients who have begun the survey but not completed it.
Opened Integer False No Count of recipients that have opened the message.
OptedOut Integer False No Count of recipients that have clicked on the opt out link.
NotSent Integer False No Count of recipients that have been added but their message has not been delivered.
Sent Integer False No Count of recipients that messages have been sent to.
Bounced Integer False No Count of recipients with messages that bounced.
LinkClicked Integer False No Count of messages where the included survey link was clicked on.

Return to Top

ContactLists

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the contact list.
Name String False No The name of the contact list.

Return to Top

Contacts

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the contact.
ContactListId String False No Use this to filter contacts only from the given ContactListId.
FirstName String False No The first name of the contact.
LastName String False No The last name of the contact.
Email String False No The email of the contact.
CustomField1 String False No The value of the first custom field for this contact.
CustomField2 String False No The value of the second custom field for this contact.
CustomField3 String False No The value of the third custom field for this contact.
CustomField4 String False No The value of the fourth custom field for this contact.
CustomField5 String False No The value of the fifth custom field for this contact.
CustomField6 String False No The value of the sixth custom field for this contact.

Return to Top

Pages

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the page.
SurveyId String False No The Id of the survey.
Title String False No The title of the page.
Description String False No The description of the page.
Position Integer False No The ordinal position of the page.
QuestionCount Integer False No The number of questions in this page.

Return to Top

RollupQuestions

Name Type ReadOnly References FilterOnly Description
SurveyId String False No The Id of the survey.
QuestionId String False SurveyQuestions.QuestionId No The Id of the question
ResponseCount Integer False No Number of people which answered by selecting this choice.
ResponseTextCount Integer False No Number of people which answered by writing in a text.
ChoiceId String False No The Id of the response.
Other Boolean False No Whether the selected choice was an other response.
Ordinal Int False No The number of the order this choice appears in the list of choices. Ordinals are used to get a meaningful representation for stats like maximum, minimum, average, median, and standard deviation.
Max Double False No The maximum value of the ordinals of the answered choices.
Min Double False No The minimum value of the ordinals of the answered choices.
Mean Double False No The average value of the ordinals of the answered choices.
Median Double False No The median value of the ordinals of the answered choices.
Std Double False No The standard deviation value of the ordinals of the answered choices.

Return to Top

Rollups

Name Type ReadOnly References FilterOnly Description
SurveyId String False No The id of the survey.
QuestionId String False SurveyQuestions.QuestionId No The id of the question
Family String False No The family this question belongs to.
Subtype String False No The subtype this question belongs to.
Answered Integer False No Number of people who answered this question by picking one of the given choices.
AnsweredOther Integer False No Number of people who answered this question by picking the other option.
Skipped Integer False No Number of people who skipped this question.

Return to Top

SurveyQuestions

Name Type ReadOnly References FilterOnly Description
SurveyId String True No The id of the survey.
QuestionId String True No The id of the question.
QuestionPosition Integer True No The position of that query in the Survey.
QuestionText String True No The text of the question.
QuestionFamily String True No The family of the question.
QuestionSubtype String True No The subtype of the question.
ChoiceId String True No The id of the choice.
ChoiceText String True No The text of the choice.
ChoiceWeight String True No The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore Int False No This field is dynamic and maps to the corresponding report field.
RowId String True No The id of the row.
RowText String True No The text of the row.
ColId String True No The id of the column.
ColText String True No The text of the column.
PageId String True No The id of the page.
PageTitle String True No The title of the page.

Return to Top

SurveyResponses

Name Type ReadOnly References FilterOnly Description
RespondentId String True No The id of the respondent, the person who answered this question.
SurveyId String True No The id of the survey.
RecipientId String True No The id of the recipient.
PageId String True No The id of the page.
QuestionId String True No The id of the question.
QuestionText String True No The text of the question.
ChoiceId String True No The id of the choice.
ChoiceText String True No The text of the choice.
ChoiceWeight String True No The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore Int False No This field is dynamic and maps to the corresponding report field.
IsCorrectChoice Boolean False No This field is dynamic and maps to the corresponding report field.
RowId String True No The id of the row.
RowText String True No The text of the row.
ColId String True No The id of the column.
ColText String True No The text of the column.
OtherId String True No The id of the other field.
OtherText String True No The text of the other field.
AnswerText String True No The text of the answer (in the case of an open-ended question).
CollectionMode String True No The mode of collection.
CollectorId String True No The id of the collector the response was taken for.
TotalTime String True No Total time spent on this survey.
ResponseStatus String True No The status of the response. Valid values are completed, partial, overquota, and disqualified.
DateCreated Datetime True No Date and time when survey was created.
DateModified Datetime True No Date and time when survey was last modified.
CustomValue Integer True No A custom value for this response.
EditUrl String True No Survey edit URL.
AnalyzeUrl String True No Survey analyze URL.
IpAddress String True No The IP address of the respondent.
QuizCorrectAnswers Int False No This field is dynamic and maps to the corresponding report field.
QuizIncorrectAnswers Int False No This field is dynamic and maps to the corresponding report field.
QuizPartiallyCorrectAnswers Int False No This field is dynamic and maps to the corresponding report field.
QuizTotalScore Int False No This field is dynamic and maps to the corresponding report field.
QuizTotalQuestions Int False No This field is dynamic and maps to the corresponding report field.
QuizMaxScore Int False No This field is dynamic and maps to the corresponding report field.
TotalTimeUnit String False Yes The unit of time you want to filter total time values with. Valids units are second, minute, and hour. If not specified, it will use second as a default value. This only affects the filtering on SurveyMonkey's end. The values returned for TotalTime from the API will still be in seconds despite what value is being sent for TotalTimeUnit.

Return to Top

Surveys

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The Id of the survey.
Title String False No The title of the survey.
Nickname String False No The nickname of the survey.
Category String False No The Category of the survey.
DateCreated Datetime False No The Date that the survey was created.
DateModified Datetime False No The Date that the survey was modified.
FolderId String False No If specified, adds the survey to the folder with that id.
IsOwner Boolean False No Is Owner of the survey.
Language String False No Language of the survey.
QuestionCount Int False No The number of questions in survey.
ResponseCount Int False No The number of responses survey has received.

Return to Top