Overview
Configuration is provided for establishing connections with the SurveyMonkey service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
Step 1. Run "Visual Studio" under "Administrator account".
Select "Data Flow task" tab and Click "Add new Data flow task"
Step 2. Right click on Connection managers Tab and Select New Connection
Step 3. In "Add SSIS Connection Manager" scroll down and select REST "Connection managers for REST Connection" and click "Add"
Step 4. From Configuration drop-down menu select "Survey Monkey" and click New
Step 5. Provide authentication details for your Survey Monkey account and click "Log in"
Step 6. Select Survey Monkey's app scopes and click "Authorize"
Step 7. Save your password protected Survey Monkey access token file and Click OK
Step 8. Click "Test" to test your connection.
Step 9. Click OK
Step 1. Open the right side panel and Drag and Drop REST Source component.
Step 2. Double click on it and from "General tab" Select "Survey Monkey Connection".
Next Select from available Survey Monkey resources listed in second drop-down menu.
Step 3. Click on Columns tab and Select from Survey Monkey available columns.
Step 4. Click Preview to view the columns data. Click OK
Step 5. Drag and drop OLE DB Destination component from the left side panel - SSIS Toolbox
Step 6. Right click Connection managers Tab and Select New OLE DB
Step 7. Select your Data connection and click OK
Step 8. Drag the blue arrow to Connect Survey Monkey source with OLE DB Destination. Select an Input and an Output to connect the components.
Step 9. Double Click on OLD DB Destination and Select Connection manager and Table name.
Step 10. Click on OLE Destination "Mapping tab" and Map the columns. Click OK
Step 11. Run the package
Step 1. Right click on "Connection managers tab" and Select New OLE DB Connection
Step 2. Select your DB connection and Click OK
Step 3. Drag and drop OLE DB Source component from the left side panel - SSIS Toolbox
Step 4. Drag and drop REST Destination component from the SSIS Toolbox and Rename it to "Survey Monkey destination"
Step 5. Double click on OLE DB Source component and Select your OLE DB connection and table name. Next Click Preview to see the data.
Step 6. Click on "Columns tab" on the left menu and Select the Columns you want to map.
Step 7. Drag the blue arrow to Connect OLE DB source with Survey Monkey destination
Step 8. Double click on "Survey Monkey destination" component, "General tab" and Select Survey Monkey connection, Action and Resource from drop down menu.
Step 9. Click on "Mappings tab" and Map the columns
Step 10. Run the package.
Configuration
Base URL address: https://api.surveymonkey.net/v3.
-
The authentication uses an authorized token.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://api.surveymonkey.net/v3/docs#new-authentication.
-
Authorization:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups/{{=SurveyMonkey.UI.GroupEditor.getValue(parameters)}}/members.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- id
A key field. Template: ShortText.
- username
Template: ShortText.
- href
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys.Documentation: https://developer.surveymonkey.com/api/v3/#surveys.
- [Create] action
-
Endpoint URL address:
/surveys.Documentation: https://developer.surveymonkey.com/api/v3/#request-body-arguments-for-post-if-creating-blank-survey.
- [Update] action
-
Endpoint URL address:
/surveys/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#surveys-id.
- [Delete] action
-
Endpoint URL address:
/surveys/{{=item.id}}.
- id
A key field. Template: ShortText.
- title
Template: ShortText.
- nickname
Template: ShortText.
- href
Template: ShortText. A read-only field.
- from_template_id
Template: ShortText.
- from_survey_id
Template: ShortText.
- custom_variables
Template: LongText. A composite field.
- footer
Data type: DT_BOOL
- preview
Template: ShortText. A read-only field.
- edit_url
Template: ShortText. A read-only field.
- collect_url
Template: ShortText. A read-only field.
- analyze_url
Template: ShortText. A read-only field.
- summary_url
Template: ShortText. A read-only field.
- response_count
Data type: DT_I4 A read-only field.
- is_owner
Data type: DT_BOOL A read-only field.
- pages
The value is gathered from
/surveys/{{=item.id}}/detailsaddress. Field components:- An array.
-
Uses template:
Page.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey_categories.Documentation: https://developer.surveymonkey.com/api/v3/#survey_categories.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey_templates.Documentation: https://developer.surveymonkey.com/api/v3/#survey_templates.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- title
Template: ShortText.
- description
Template: LongText.
- category
Template: ShortText.
- available
Data type: DT_BOOL
- num_questions
Data type: DT_I4
- preview_link
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/pages.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- [Create] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/pages.
- [Update] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/pages/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#surveys-id-pages-id.
- [Delete] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/pages/{{=item.id}}.
The resource includes the fields from the Page template.
- survey_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/pages/{{=SurveyMonkey.UI.PageEditor.getValue(parameters)}}/questions.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- page_id: Required. Specify survey page identifier.
- [Create] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/pages/{{=item.page_id}}/questions.
- [Update] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/pages/{{=item.page_id}}/questions/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#surveys-id-pages-id-questions-id.
- [Delete] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/pages/{{=item.page_id}}/questions/{{=item.id}}.
The resource includes the fields from the Question template.
- survey_id
A key field. Template: ShortText.
- page_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact_lists.
- [Create] action
-
Endpoint URL address:
/contact_lists.
- [Update] action
-
Endpoint URL address:
/contact_lists/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/contact_lists/{{=item.id}}.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- href
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact_lists/{{=parameters.list_id}}/contacts.The action has the following user-defined parameters:
- list_id: Required. Specify contact list identifier.
- [Create] action
-
Endpoint URL address:
/contact_lists/{{=item.list_id}}/contacts.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.surveymonkey.com/api/v3/#contact_lists-id-contacts.
-
application/json:
The resource includes the fields from the Contact template.
- list_id
Template: ShortText.
- [External]
-
The external fields URL address:
/contact_fields. The external fields list is extracted from:{{=response.data}}.- custom.{{=external.id}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.
- [Create] action
-
Endpoint URL address:
/contacts/bulk.
The result is extracted from:{{=response.succeeded}}.The following request parameters will be automatically processed:
-
application/json:
{{={ contacts: batch } }}
Documentation: https://developer.surveymonkey.com/api/v3/#contacts-bulk.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#contacts-id.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#contacts-id.
The resource includes the fields from the Contact template.
- [External]
-
The external fields URL address:
/contact_fields. The external fields list is extracted from:{{=response.data}}.- custom.{{=external.id}}
Template: ShortText. The value is gathered from
/contacts/{{=item.id}}address. The gathered value is processed with{{=response.custom_fields[field.external.id]}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact_fields.
- id
A key field. Template: ShortText.
- label
Template: ShortText.
- href
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/collectors.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- [Create] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/collectors.Documentation: https://developer.surveymonkey.com/api/v3/#surveys-id-collectors.
- [Update] action
-
Endpoint URL address:
/collectors/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/collectors/{{=item.id}}.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- href
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/collectors/{{=parameters.collector_id}}/messages.The action has the following user-defined parameters:
- collector_id: Required. Specify collector identifier.
- [Create] action
-
Endpoint URL address:
/collectors/{{=item.collector_id}}/messages.
- [Update] action
-
Endpoint URL address:
/collectors/{{=item.collector_id}}/messages/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#collectors-id-messages-id.
- [Delete] action
-
Endpoint URL address:
/collectors/{{=item.collector_id}}/messages/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#collectors-id-messages-id.
- id
A key field. Template: ShortText.
- status
Template: ShortText. A read-only field.
- is_scheduled
Data type: DT_BOOL A read-only field.
- is_branding_enabled
Data type: DT_BOOL
- date_created
Template: DateTime. A read-only field.
- type
Template: ShortText.
- recipient_status
Template: ShortText.
- from_collector_id
Template: ShortText.
- from_message_id
Template: ShortText.
- include_recipients
Data type: DT_BOOL
- subject
Template: ShortText.
- body_text
Template: LongText.
- body_html
Template: LongText.
- collector_id
A key field. Template: ShortText.
- embed_first_question
Data type: DT_BOOL
- recipients
The gathered value is processed with
{{=connection.resourceManager['Collector Message Recipient'].getData({ parameters: ['collector_id=' + parameters.collector_id, 'message_id=' + item.id] })}}expression. The value is sent to/collectors/{{=item.collector_id}}/messages/{{=item.id}}/recipients/bulkaddress. Field components:- An array.
-
Uses template:
MessageRecipient.
- scheduled_date
Template: DateTime. The value is sent to
/collectors/{{=item.collector_id}}/messages/{{=item.id}}/sendaddress.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/collectors/{{=parameters.collector_id}}/messages/{{=parameters.message_id}}/recipients.The action has the following user-defined parameters:
- collector_id: Required. Specify collector identifier.
- message_id: Required. Specify message identifier.
- [Create] action
-
Endpoint URL address:
/collectors/{{=item.collector_id}}/messages/{{=item.message_id}}/recipients.
The result is extracted from:{{=response.succeeded}}.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.surveymonkey.com/api/v3/#collectors-id-messages-id-recipients.
-
application/json:
The resource includes the fields from the MessageRecipient template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/collectors/{{=parameters.collector_id}}/recipients.The action has the following user-defined parameters:
- collector_id: Required. Specify collector identifier.
- [Delete] action
-
Endpoint URL address:
/collectors/{{=item.collector_id}}/recipients/{{=item.id}}.
- id
A key field. Template: ShortText.
Template: ShortText.
- href
Template: ShortText.
- collector_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/responses/bulk.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- [Update] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/responses/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/surveys/{{=item.survey_id}}/responses/{{=item.id}}.
The resource includes the fields from the Response template.
- survey_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/collectors/{{=parameters.collector_id}}/responses/bulk.The action has the following user-defined parameters:
- collector_id: Required. Specify collector identifier.
- [Update] action
-
Endpoint URL address:
/collectors/{{=item.collector_id}}/responses/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/collectors/{{=item.collector_id}}/responses/{{=item.id}}.
The resource includes the fields from the Response template.
- collector_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/rollups.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
The resource includes the fields from the Rollup template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/pages/{{=SurveyMonkey.UI.PageEditor.getValue(parameters)}}/rollups.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- page_id: Required. Specify page identifier.
The resource includes the fields from the Rollup template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/pages/{{=SurveyMonkey.UI.PageEditor.getValue(parameters)}}/questions/{{=parameters.question_id}}/rollups.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- page_id: Required. Specify page identifier.
- question_id: Required. Specify question identifier.
The resource includes the fields from the Rollup template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/trends.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
The resource includes the fields from the Trend template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/pages/{{=SurveyMonkey.UI.PageEditor.getValue(parameters)}}/trends.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- page_id: Required. Specify page identifier.
The resource includes the fields from the Trend template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=SurveyMonkey.UI.SurveyEditor.getValue(parameters)}}/pages/{{=SurveyMonkey.UI.PageEditor.getValue(parameters)}}/questions/{{=parameters.question_id}}/trends.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- page_id: Required. Specify page identifier.
- question_id: Required. Specify question identifier.
The resource includes the fields from the Trend template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhooks.
- [Create] action
-
Endpoint URL address:
/webhooks.
- [Update] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#webhooks-id.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developer.surveymonkey.com/api/v3/#webhooks-id.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- href
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/benchmark_bundles.
- id
A key field. Template: ShortText.
- title
Template: ShortText.
- href
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/benchmark_bundles/{{=SurveyMonkey.UI.BundleEditor.getValue(parameters)}}/analyze.The action has the following user-defined parameters:
- bundle_id: Required. Specify bundle identifier.
- id
A key field. Template: ShortText.
- date_start
Template: DateTime.
- date_end
Template: DateTime.
- benchmarks
Field components:
- An array.
- Contains the following components: id, num_responses, num_data_points, question, quartile_values, distribution_values.
Based on resource template Base.
- id
A key field. Template: ShortText.
- date_start
Template: DateTime.
- date_end
Template: DateTime.
- benchmark
Field components:
-
Uses template:
LongText. - Contains the following components: num_responses, num_data_points, quartile_values, distribution_values, data_point_type_distribution.
-
Uses template:
- [Read] action
-
The result is extracted from:{{=response.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Question
Field components:
-
Uses template:
ShortText. - Contains the following components: id, heading, href, position.
-
Uses template:
- Page
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, description, position, question_count, questions.
-
Uses template:
- Contact
Field components:
-
Uses template:
ShortText. - Contains the following components: id, first_name, last_name, email, href.
-
Uses template:
- Response
Field components:
-
Uses template:
ShortText. - Contains the following components: id, href, recipient_id, total_time, custom_value, edit_url, analyze_url, ip_address, custom_variables, logic_path, metadata, response_status, page_path, collection_mode, date_created, date_modified, pages.
-
Uses template:
- Rollup
Field components:
-
Uses template:
ShortText. - Contains the following components: id, href, subtype, family, summary.
-
Uses template:
- Trend
Field components:
-
Uses template:
ShortText. - Contains the following components: id, href, trend_by, subtype, skipped, family, answered, trends.
-
Uses template:
- Button
Field components:
-
Uses template:
ShortText. - Contains the following components: bg_color, text_color, text.
-
Uses template:
- MessageRecipient
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email, phone_number, href, survey_response_status, mail_status, custom_fields, remove_link, extra_fields, survey_link, collector_id, message_id, first_name, last_name, contact_id.
-
Uses template:
What's New
- New: Improved parameter entry.
- Fixed: Various fixes (Thank you, Michael).
- Fixed: Incorrect composite definitions.
- Fixed: Question detail was not retrieved (Thank you, Stu).
- Fixed: Failed to create a record in 'Survey Collector' resource (Thank you, Joelle).
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.