Connectors Reference

SurveyMonkey

SurveyMonkey is the world's leading provider of web-based survey solutions. These solutions are used by companies, organizations, and individuals to gather the insights they need to make more informed decisions.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

GetSurveys ()

List surveys

GetSurveyCollector (string collectorId)

Get a collector

GetSurveyMessages (string collectorId)

Get messages

GetSurveyCollectors (string surveyId)

List collectors

GetSurvey (string surveyId)

Get a survey

SendMessage (string surveyId, string collectorId, string messageId, [Optional]SendMessageParameterBody body)

Schedule an existing invite message

 

Triggers:

Name

Summary

OnSurveyCreated ()

When a new survey is created

OnSurveyCollectorCreated (string surveyId)

When a new collector is created

OnNewResponseAddedCollector (string surveyId, string collectorId)

When a new collector response is added

OnNewResponseAddedSurvey (string surveyId)

When a new survey response is added

 

Objects:

Name

Summary

OnNewResponseAddedCollectorResponseItem

 

OnSurveyCollectorCreatedResponseItem

 

OnSurveyCreatedResponseItem

 

SendMessageParameterBody

 

Survey

 

SurveyCollector

 

SurveyCollectors

 

SurveyMessageResponse

 

SurveyMessages

 

Surveys

 

 

Actions:

GetSurveys

Summary: List surveys

Description: List the surveys in the account.

 

Syntax:

SurveyMonkey.GetSurveys ()

 

Returns:

          Type:Surveys

 

GetSurveyCollector

Summary: Get a collector

Description: Get details of a specific collector.

 

Syntax:

SurveyMonkey.GetSurveyCollector (string collectorId)

 

Parameters:

Name

Type

Summary

Required

Related Action

collectorId

string

(Collector Id)

 

True

 

Returns:

          Type:SurveyCollector

 

GetSurveyMessages

Summary: Get messages

Description: Get survey messages for a given survey collector.

 

Syntax:

SurveyMonkey.GetSurveyMessages (string collectorId)

 

Parameters:

Name

Type

Summary

Required

Related Action

collectorId

string

(Collector Id)

 

True

 

Returns:

          Type:SurveyMessages

 

GetSurveyCollectors

Summary: List collectors

Description: Get a list of collectors for a given survey.

 

Syntax:

SurveyMonkey.GetSurveyCollectors (string surveyId)

 

Parameters:

Name

Type

Summary

Required

Related Action

surveyId

string

(Survey Id)

Select a survey

True

GetSurveys

 

Returns:

          Type:SurveyCollectors

 

GetSurvey

Summary: Get a survey

Description: Get details of a specific survey.

 

Syntax:

SurveyMonkey.GetSurvey (string surveyId)

 

Parameters:

Name

Type

Summary

Required

Related Action

surveyId

string

(Survey Id)

The id of the survey

True

 

Returns:

          Type:Survey

 

SendMessage

Summary: Schedule an existing invite message

Description: Send or schedule to send an existing message to all message recipients.

 

Syntax:

SurveyMonkey.SendMessage (string surveyId, string collectorId, string messageId, [Optional]SendMessageParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

surveyId

string

(Survey Id)

Select a survey

True

GetSurveys

collectorId

string

(Collector Id)

Select a collector

True

GetSurveyCollectors

messageId

string

(Message Id)

Select a message

True

GetSurveyMessages

body

SendMessageParameterBody

 

 

False

 

Returns:

          Type:SurveyMessageResponse

 

Triggers:

Trigger OnSurveyCreated

Summary: When a new survey is created

Description: Triggers a new flow when a survey is created.

 

Syntax:

SurveyMonkey.OnSurveyCreated ()

 

Returns:

          Type:array of (OnSurveyCreatedResponseItem)

 

Trigger OnSurveyCollectorCreated

Summary: When a new collector is created

Description: Triggers a new flow when a collector is created.

 

Syntax:

SurveyMonkey.OnSurveyCollectorCreated (string surveyId)

 

Parameters:

Name

Type

Summary

Required

Related Action

surveyId

string

(Survey Id)

Select a survey

True

GetSurveys

 

Returns:

          Type:array of (OnSurveyCollectorCreatedResponseItem)

 

Trigger OnNewResponseAddedCollector

Summary: When a new collector response is added

Description: Triggers a new flow when a response is added (paid account only).

 

Syntax:

SurveyMonkey.OnNewResponseAddedCollector (string surveyId, string collectorId)

 

Parameters:

Name

Type

Summary

Required

Related Action

surveyId

string

(Survey Id)

Select a survey

True

GetSurveys

collectorId

string

(Collector Id)

Select a collector

True

GetSurveyCollectors

 

Returns:

          Type:array of (OnNewResponseAddedCollectorResponseItem)

 

Trigger OnNewResponseAddedSurvey

Summary: When a new survey response is added

Description: Triggers a new flow when a survey response is added (paid account only).

 

Syntax:

SurveyMonkey.OnNewResponseAddedSurvey (string surveyId)

 

Parameters:

Name

Type

Summary

Required

Related Action

surveyId

string

(Survey Id)

Select a survey

True

GetSurveys

 

Returns:

          Type:array of (OnNewResponseAddedCollectorResponseItem)

 


 

OnNewResponseAddedCollectorResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

total_time

integer(int32)

Time Spent

Total time spent on the response.

href

string

Link

Survey response link.

ip_address

string

IP Address

IP address of responder.

id

string

Response Id

The response identifier.

date_modified

string(date-time)

Modified Date

The date the response was last modified.

response_status

string

Response Status

Status of the response.

custom_value

string

Custom Value

Custom value associated with a response.

analyze_url

string

Analyze Url

Link to the analyze page to view the response.

recipient_id

string

Recipient Id

The recipient identifier.

collector_id

string

Collector Id

The collector identifier.

date_created

string(date-time)

Created Date

The date the response was created.

survey_id

string

Survey Id

The survey identifier.

collection_mode

string

Collection Mode

Response collection mode.

edit_url

string

Edit Url

Link to the survey page to edit the response.


 

OnSurveyCollectorCreatedResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

href

string

Link

Link to survey collector.

id

string

Collector Id

The collector identifier.

name

string

Name

The name of the collector.


 

OnSurveyCreatedResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

href

string

Link

Link to the survey.

id

string

Survey Id

The survey identifier.

title

string

Title

The title of the survey.


 

SendMessageParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

scheduled_date

string(date-time)

Scheduled date

Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z)


 

Survey

Summary:

Description:

 

          Properties:

Name

Type

Summary

response_count

integer(int32)

Response Count

Number of responses survey has received.

page_count

integer(int32)

Page Count

Number of pages in the survey.

id

string

Survey Id

The survey identifier.

question_count

integer(int32)

Question Count

Number of questions in survey.

category

string

Survey Category

Survey category chosen when creating the survey.

preview

string

Preview Url

Survey preview URL.

language

string

Language

Survey language.

date_modified

string(date-time)

Modified Date

The date the survey was last modified.

title

string

Title

The title of the survey.

analyze_url

string

Analyze Url

The URL for the results of the survey.

summary_url

string

Summary Url

The URL for the summary of the survey.

date_created

string(date-time)

Created Date

The date the survey was created.

collect_url

string

Collect Url

Survey collect URL.

edit_url

string

Edit Url

Survey edit URL.


 

SurveyCollector

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

string

Status

The status of the survey.

redirect_url

string

Survey Redirect Url

Redirect to this url upon survey completion.

thank_you_message

string

Thank You Message

Message for thank you page.

response_count

integer(int32)

Response Count

The number of survey responses.

closed_page_message

string

Closed Message

Message shown when a survey is closed.

href

string

Link

Link to the survey collector.

close_date

string

Close Date

Close date of collector.

id

string

Collector Id

The collector identifier.

name

string

Name

The name of the collector.

date_modified

string(date-time)

Modified Date

The date the collector was last modified.

edit_response_type

string

Response Type

Type of response.

sender_email

string

Sender Email

Collector sender email.

date_created

string(date-time)

Created Date

The date the collector was created.

disqualification_message

string

Disqualification Date

Message for disqualification page.

type

string

Collector Type

Collector type: 'weblink’ or 'email’.


 

SurveyCollectors

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

 

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

href

string

Link

Link to collector.

name

string

Name

The name of the collector.

id

string

Collector Id

The collector identifier.

 


 

SurveyMessageResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

is_scheduled

string

Link

Link to message results.

scheduled_date

string(date-time)

Scheduled Date

Date message was scheduled to be sent.

body

string

Message Body

The plain text body of the email message to be sent to recipients.

subject

string

Subject

Subject of the email message to be sent to recipients.

recipients

array of (string)

Recipients

List of recipient ids.

recipient_status

string

States

The recipient status.

type

string

 

 


 

SurveyMessages

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

 

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

string

Message status

The status of the message.

href

string

Link

Link to message.

type

string

Type

Type of message.

id

string

Message Id

The message identifier.

 


 

Surveys

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

 

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

href

string

Link

Link to the survey.

id

string

Survey Id

The survey identifier.

title

string

Title

The title of the survey.