SurveyMonkey Connection
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.
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}}
For further information, please check here.
-
Authorization:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Question
Contains the following components: id, headings, href, position, family, forced_ranking, required, sorting, subtype, validation, visible, answers, display_options.
- Page
Contains the following components: id, title, description, position, question_count, questions.
- Contact
Contains the following components: id, first_name, last_name, email, href.
- Response
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.
- Rollup
Contains the following components: id, href, subtype, family, summary.
- Trend
Contains the following components: id, href, trend_by, subtype, skipped, family, answered, trends.
- [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}} -
params:
{{=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.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/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.For further information check here.
- [Create] action
-
Endpoint URL address:
/surveys.For further information check here.
- [Update] action
-
Endpoint URL address:
/surveys/{{=item.id}}.For further information check here.
- [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.
- category
Template: ShortText.
- language
Template: ShortText.
- question_count
Data type: DT_I4 A read-only field.
- page_count
Data type: DT_I4 A read-only field.
- date_created
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- buttons_text
Contains the following components: done_button, prev_button, exit_button, next_button.
- 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.
- pages
Template: Page. An array field.
- is_owner
Data type: DT_BOOL A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey_templates.For further information check here.
- 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/{{=parameters.survey_id}}/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}}.For further information check here.
- [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/{{=parameters.survey_id}}/pages/{{=parameters.page_id}}/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}}.For further information check here.
- [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/bulk.
The result is extracted from:{{=response.succeeded}}.The following request parameters will be automatically processed:
-
application/json:
{{={ contacts: batch } }}
For further information check here.
-
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 } }}
For further information check here.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.For further information check here.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.For further information check here.
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.
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/{{=parameters.survey_id}}/collectors.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- [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.
- status
Template: ShortText. A read-only field.
- type
Template: ShortText.
- name
Template: ShortText.
- thank_you_message
Template: LongText.
- disqualification_message
Template: LongText.
- close_date
Template: DateTime.
- closed_page_message
Template: LongText.
- redirect_url
Template: ShortText.
- display_survey_results
Data type: DT_BOOL
- edit_response_type
Template: ShortText.
- anonymous_type
Template: ShortText.
- allow_multiple_responses
Data type: DT_BOOL
- date_modified
Template: DateTime. A read-only field.
- url
Template: ShortText. A read-only field.
- date_created
Template: DateTime. A read-only field.
- password_enabled
Data type: DT_BOOL A read-only field.
- password
Template: ShortText.
- sender_email
Template: ShortText.
- response_limit
Data type: DT_I4
- redirect_type
Template: ShortText.
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}}.For further information check here.
- [Delete] action
-
Endpoint URL address:
/collectors/{{=item.collector_id}}/messages/{{=item.id}}.For further information check here.
- 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.
- scheduled_date
Template: DateTime.
- 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.
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/bulk.
The result is extracted from:{{=response.succeeded}}.The following request parameters will be automatically processed:
-
application/json:
{{={ contacts: batch } }}
For further information check here.
-
application/json:
- id
A key field. Template: ShortText.
Template: ShortText.
- href
Template: ShortText. A read-only field.
- survey_response_status
Template: ShortText. A read-only field.
- mail_status
Template: ShortText. A read-only field.
- custom_fields
Template: LongText. A composite field.
- remove_link
Template: ShortText. A read-only field.
- extra_fields
Template: LongText. A composite field.
- survey_link
Template: ShortText. A read-only field.
- collector_id
A key field. Template: ShortText.
- message_id
A key field. Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
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.
- survey_response_status
Template: ShortText.
- mail_status
Template: ShortText.
- custom_fields
Template: LongText. A composite field.
- remove_link
Template: ShortText.
- extra_fields
Template: LongText. A composite field.
- survey_link
Template: ShortText.
- collector_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveys/{{=parameters.survey_id}}/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/{{=parameters.survey_id}}/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/{{=parameters.survey_id}}/pages/{{=parameters.page_id}}/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/{{=parameters.survey_id}}/pages/{{=parameters.page_id}}/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/{{=parameters.survey_id}}/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/{{=parameters.survey_id}}/pages/{{=parameters.page_id}}/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/{{=parameters.survey_id}}/pages/{{=parameters.page_id}}/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}}.For further information check here.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.For further information check here.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- href
Template: ShortText. A read-only field.
- event_type
Template: ShortText.
- object_type
Template: ShortText.
- object_ids
Template: LongText. A composite field.
- subscription_url
Template: ShortText.
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.
- details
Contains the following components: bullets, subtext.
- questions
An array field. Contains the following components: id, title, answer_order, answers.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/benchmark_bundles/{{=parameters.bundle_id}}/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
An array field. 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
Contains the following components: num_responses, num_data_points, quartile_values, distribution_values, data_point_type_distribution.
What's New
- New: Introduced connection.
Ready to give it a try?
COZYROC SSIS+ Components Suite is free for testing in your development environment.