SurveyMonkey

SurveyMonkey is an online survey tool used to create online surveys, polls, and quizzes. You can use SurveyMonkey as a data source when landing or replicating data. The SurveyMonkey account must be a paid subscription.

SurveyMonkey integration replicates data using the SurveyMonkey REST API v3.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To retrieve the access token of an existing app:

Log in to https://developer.surveymonkey.com.
Click My Apps.
Click Settings on the app.
Copy Access Token to Access Token in the connection settings.

For more information about authentication, see Authentication.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Access Token	Access token for a private app in SurveyMonkey.
Survey ID	Survey ID.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 2.

Depending on your destination, table and column names may not appear as they are outlined below.

responses

This table contains information about your survey responses.

Replication Method	CDC
Primary Key	id
Replication Key	date_modified
Useful links	SurveyMonkey documentation SurveyMonkey API method

Join responses with	on
simplified_responses	responses.id = simplified_responses.id responses.survey_id = simplified_responses.survey_id
survey_details	responses.survey_id = survey_details.id

Join responses with

simplified_responses

responses.id = simplified_responses.id

responses.survey_id = simplified_responses.survey_id

survey_details

responses.survey_id = survey_details.id

analyze_url

STRING

collection_mode

STRING

collector_id

STRING

custom_value

STRING

custom_variables

OBJECT

This is a nested data structure.

date_created

DATE-TIME

date_modified

DATE-TIME

edit_url

STRING

email_address

STRING

first_name

STRING

href

STRING

ip_address

STRING

last_name

STRING

logic_path

OBJECT

This is a nested data structure.

metadata

OBJECT

This is a nested data structure.

page_path

ARRAY

This is a nested data structure.

pages

ARRAY

This is a nested data structure:

id: STRING
questions: ARRAY, which is also a nested data structure.
- answers: ARRAY, which is also a nested data structure.
  - choice_id: STRING
  - col_id: STRING
  - image: STRING
  - is_correct: BOOLEAN
  - other_id: STRING
  - row_id: STRING
  - score: INTEGER
  - tag_data: ARRAY, which is also a nested data structure.
  - text: STRING
- id: STRING
- variable_id: STRING

quiz_results

OBJECT

This is a nested data structure:

correct: INTEGER
incorrect: INTEGER
partially_correct: INTEGER
score: INTEGER
total_questions: INTEGER
total_score: INTEGER

recipient_id

STRING

response_status

STRING

survey_id

STRING

total_time

INTEGER

simplified_responses

This table contains a simplified version of information about your survey responses.

Replication Method	CDC
Primary Key	id
Replication Key	date_modified
Useful links	SurveyMonkey documentation SurveyMonkey API method

Join simplified_responses with	on
responses	simplified_responses.id = responses.id simplified_responses.survey_id = responses.survey_id
survey_details	simplified_responses.survey_id = survey_details.id

Join simplified_responses with

responses

simplified_responses.id = responses.id

simplified_responses.survey_id = responses.survey_id

survey_details

simplified_responses.survey_id = survey_details.id

analyze_url

STRING

collection_mode

STRING

collector_id

STRING

custom_value

STRING

custom_variables

OBJECT

This is a nested data structure.

date_created

DATE-TIME

date_modified

DATE-TIME

edit_url

STRING

email_address

STRING

first_name

STRING

href

STRING

ip_address

STRING

last_name

STRING

logic_path

OBJECT

This is a nested data structure.

metadata

OBJECT

This is a nested data structure.

page_path

ARRAY

This is a nested data structure.

pages

ARRAY

This is a nested data structure:

id: STRING
questions: ARRAY, which is also a nested data structure.
- answers: ARRAY, which is also a nested data structure.
  - choice_id: STRING
  - col_id: STRING
  - image: STRING
  - is_correct: BOOLEAN
  - other_id: STRING
  - row_id: STRING
  - score: INTEGER
  - simple_text: STRING
  - tag_data: ARRAY, which is also a nested data structure.
  - text: STRING
- family: STRING
- heading: STRING
- id: STRING
- subtype: STRING
- variable_id: STRING

quiz_results

OBJECT

This is a nested data structure:

correct: INTEGER
incorrect: INTEGER
partially_correct: INTEGER
score: INTEGER
total_questions: INTEGER
total_score: INTEGER

recipient_id

STRING

response_status

STRING

survey_id

STRING

total_time

INTEGER

survey_details

This table contains information about your survey details.

Replication Method	CDC
Primary Key	id
Replication Key	date_modified
Useful links	SurveyMonkey documentation SurveyMonkey API method

Join survey_details with	on
responses	survey_details.id = responses.survey_id
simplified_responses	survey_details.id = simplified_responses.survey_id

analyze_url

STRING

buttons_text

OBJECT

This is a nested data structure:

done_button: STRING
exit_button: STRING
next_button: STRING
prev_button: STRING

category

STRING

collect_url

STRING

custom_variables

OBJECT

This is a nested data structure.

date_created

DATE-TIME

date_modified

DATE-TIME

edit_url

STRING

folder_id

STRING

footer

BOOLEAN

href

STRING

is_owner

BOOLEAN

language

STRING

nickname

STRING

page_count

INTEGER

pages

ARRAY

This is a nested data structure:

description: STRING
href: STRING
id: STRING
position: INTEGER
question_count: INTEGER
questions: ARRAY, which is also a nested data structure.
- answers: OBJECT, which is also a nested data structure.
  - choices: ARRAY, which is also a nested data structure.
    - description: STRING
    - id: STRING
    - image: OBJECT, which is also a nested data structure.
      - s3_key: STRING
      - url: STRING
    - is_na: BOOLEAN
    - position: INTEGER
    - quiz_options: OBJECT, which is also a nested data structure.
      - score: INTEGER
    - text: STRING
    - visible: BOOLEAN
    - weight: INTEGER
  - cols: ARRAY, which is also a nested data structure.
  - other: OBJECT, which is also a nested data structure.
  - rows: ARRAY, which is also a nested data structure.
- display_options: OBJECT, which is also a nested data structure.
  - show_display_number: BOOLEAN
- family: STRING
- forced_ranking: BOOLEAN
- headings: ARRAY, which is also a nested data structure.
  - description: STRING
  - heading: STRING
  - image: OBJECT, which is also a nested data structure.
    - s3_key: STRING
    - url: STRING
  - random_assignment: OBJECT, which is also a nested data structure.
    - description: STRING
    - id: STRING
    - percent: NUMBER
    - position: INTEGER
    - variable_name: STRING
- href: STRING
- id: STRING
- layout: OBJECT, which is also a nested data structure.
  - bottom_spacing: NUMBER
  - col_width: NUMBER
  - col_width_format: STRING
  - left_spacing: NUMBER
  - num_chars: NUMBER
  - num_lines: NUMBER
  - position: STRING
  - right_spacing: NUMBER
  - top_spacing: NUMBER
  - width: NUMBER
  - width_format: STRING
- nickname: STRING
- position: INTEGER
- quiz_options: OBJECT, which is also a nested data structure.
  - feedback: OBJECT, which is also a nested data structure.
    - correct_text: STRING
    - incorrect_text: STRING
    - partial_text: STRING
  - scoring_enabled: BOOLEAN
- required: OBJECT, which is also a nested data structure.
  - amount: STRING
  - text: STRING
  - type: STRING
- sorting: OBJECT, which is also a nested data structure.
  - ignore_last: BOOLEAN
  - type: STRING
- subtype: STRING
- validation: OBJECT, which is also a nested data structure.
  - max: STRING
  - min: STRING
  - sum: INTEGER
  - sum_text: STRING
  - text: STRING
  - type: STRING
- visible: BOOLEAN
title: STRING

preview

STRING

question_count

INTEGER

quiz_options

OBJECT

This is a nested data structure:

feedback: OBJECT, which is also a nested data structure.
- ranges: ARRAY, which is also a nested data structure.
  - max: STRING
  - message: STRING
  - min: STRING
- ranges_type: STRING
is_quiz_mode: BOOLEAN
show_results_type: STRING

response_count

INTEGER

summary_url

STRING

title

STRING

surveys

This table contains information about your surveys.

Replication Method	CDC
Primary Key	id
Replication Key	date_modified
Useful links	SurveyMonkey documentation

date_created

DATE-TIME

date_modified

DATE-TIME

STRING

language

STRING

nickname

STRING

question_count

INTEGER

response_count

INTEGER

title

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here