# 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](https://developer.surveymonkey.com/api/v3/).

See the [Schema](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-SurveyMonkey-v2.htm#Schema) section for a list of objects available for replication.

## Preparing for authentication

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

Information noteMake 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:

1. Log in to https://developer.surveymonkey.com.

2. Click My Apps.

3. Click Settings on the app.

4. Copy Access Token to Access Token in the connection settings.

For more information about authentication, see [Authentication](https://www.surveymonkey.com/developer/api/v3/#authentication).

## Creating the connection

For more information, see [Connecting to SaaS applications](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/Landing/connecting-web-applications.htm).

1. Fill in the required connection properties.

2. Provide a name for the connection in Connection name.

3. Select Open connection metadata to define metadata for the connection when it has been created.

4. Click Create.

Connection settings

| Setting | Description |
| --- | --- |
| Data gateway | Select a Data Movement gateway if required by your use case.<br><br>Information note<br><br>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.<br><br>For information on the benefits of Data Movement gateway and use cases that require it, see [Qlik Data Gateway - Data Movement](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Gateways/replication-gateway.htm). |
| 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

Information note

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

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](https://developer.surveymonkey.com/api/v3/)<br><br>[SurveyMonkey API method](https://developer.surveymonkey.com/api/v3/#collectors-id-responses-id-details "Opens in new tab: SurveyMonkey API method") |

responses table foreign keys

| Join responses with | on |
| --- | --- |
| [simplified_responses](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-SurveyMonkey-v2.htm#simplified-responses) | ```<br>responses.id = simplified_responses.id<br>```<br><br>```<br>responses.survey_id = simplified_responses.survey_id<br>``` |
| [survey_details](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-SurveyMonkey-v2.htm#survey-details) | ```<br>responses.survey_id = survey_details.id<br>``` |

responses table schema

| **analyze\_url**<br><br><br>STRING |
| --- |
| **collection\_mode**<br><br><br>STRING |
| **collector\_id**<br><br><br>STRING |
| **custom\_value**<br><br><br>STRING |
| **custom\_variables**<br><br><br>OBJECT<br><br>This is a nested data structure. |
| **date\_created**<br><br><br>DATE-TIME |
| **date\_modified**<br><br><br>DATE-TIME |
| **edit\_url**<br><br><br>STRING |
| **email\_address**<br><br><br>STRING |
| **first\_name**<br><br><br>STRING |
| **href**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **ip\_address**<br><br><br>STRING |
| **last\_name**<br><br><br>STRING |
| **logic\_path**<br><br><br>OBJECT<br><br>This is a nested data structure. |
| **metadata**<br><br><br>OBJECT<br><br>This is a nested data structure. |
| **page\_path**<br><br><br>ARRAY<br><br>This is a nested data structure. |
| **pages**<br><br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>questions: ARRAY, which is also a nested data structure.											<ul><li>answers: ARRAY, which is also a nested data structure.													<ul><li>choice_id: STRING</li><li>col_id: STRING</li><li>image: STRING</li><li>is_correct: BOOLEAN</li><li>other_id: STRING</li><li>row_id: STRING</li><li>score: INTEGER</li><li>tag_data: ARRAY, which is also a nested data structure.</li><li>text: STRING</li></ul></li><li>id: STRING</li><li>variable_id: STRING</li></ul></li></ul> |
| **quiz\_results**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>correct: INTEGER</li><li>incorrect: INTEGER</li><li>partially_correct: INTEGER</li><li>score: INTEGER</li><li>total_questions: INTEGER</li><li>total_score: INTEGER</li></ul> |
| **recipient\_id**<br><br><br>STRING |
| **response\_status**<br><br><br>STRING |
| **survey\_id**<br><br><br>STRING |
| **total\_time**<br><br><br>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](https://developer.surveymonkey.com/api/v3/)<br><br>[SurveyMonkey API method](https://developer.surveymonkey.com/api/v3/#collectors-id-responses-id-details "Opens in new tab: SurveyMonkey API method") |

simplified\_responses table foreign keys

| Join simplified\_responses with | on |
| --- | --- |
| [responses](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-SurveyMonkey-v2.htm#responses) | ```<br>simplified_responses.id = responses.id<br>```<br><br>```<br>simplified_responses.survey_id = responses.survey_id<br>``` |
| [survey_details](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-SurveyMonkey-v2.htm#survey-details) | ```<br>simplified_responses.survey_id = survey_details.id<br>``` |

simplified\_responses table schema

| **analyze\_url**<br><br><br>STRING |
| --- |
| **collection\_mode**<br><br><br>STRING |
| **collector\_id**<br><br><br>STRING |
| **custom\_value**<br><br><br>STRING |
| **custom\_variables**<br><br><br>OBJECT<br><br>This is a nested data structure. |
| **date\_created**<br><br><br>DATE-TIME |
| **date\_modified**<br><br><br>DATE-TIME |
| **edit\_url**<br><br><br>STRING |
| **email\_address**<br><br><br>STRING |
| **first\_name**<br><br><br>STRING |
| **href**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **ip\_address**<br><br><br>STRING |
| **last\_name**<br><br><br>STRING |
| **logic\_path**<br><br><br>OBJECT<br><br>This is a nested data structure. |
| **metadata**<br><br><br>OBJECT<br><br>This is a nested data structure. |
| **page\_path**<br><br><br>ARRAY<br><br>This is a nested data structure. |
| **pages**<br><br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>id: STRING</li><li>questions: ARRAY, which is also a nested data structure.											<ul><li>answers: ARRAY, which is also a nested data structure.													<ul><li>choice_id: STRING</li><li>col_id: STRING</li><li>image: STRING</li><li>is_correct: BOOLEAN</li><li>other_id: STRING</li><li>row_id: STRING</li><li>score: INTEGER</li><li>simple_text: STRING</li><li>tag_data: ARRAY, which is also a nested data structure.</li><li>text: STRING</li></ul></li><li>family: STRING</li><li>heading: STRING</li><li>id: STRING</li><li>subtype: STRING</li><li>variable_id: STRING</li></ul></li></ul> |
| **quiz\_results**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>correct: INTEGER</li><li>incorrect: INTEGER</li><li>partially_correct: INTEGER</li><li>score: INTEGER</li><li>total_questions: INTEGER</li><li>total_score: INTEGER</li></ul> |
| **recipient\_id**<br><br><br>STRING |
| **response\_status**<br><br><br>STRING |
| **survey\_id**<br><br><br>STRING |
| **total\_time**<br><br><br>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](https://developer.surveymonkey.com/api/v3/)<br><br>[SurveyMonkey API method](https://developer.surveymonkey.com/api/v3/#surveys "Opens in new tab: SurveyMonkey API method") |

survey\_details table foreign keys

| Join survey\_details with | on |
| --- | --- |
| [responses](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-SurveyMonkey-v2.htm#responses) | ```<br>survey_details.id = responses.survey_id<br>``` |
| [simplified_responses](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-SurveyMonkey-v2.htm#simplified-responses) | ```<br>survey_details.id = simplified_responses.survey_id<br>``` |

survey\_details table schema

| **analyze\_url**<br><br><br>STRING |
| --- |
| **buttons\_text**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>done_button: STRING</li><li>exit_button: STRING</li><li>next_button: STRING</li><li>prev_button: STRING</li></ul> |
| **category**<br><br><br>STRING |
| **collect\_url**<br><br><br>STRING |
| **custom\_variables**<br><br><br>OBJECT<br><br>This is a nested data structure. |
| **date\_created**<br><br><br>DATE-TIME |
| **date\_modified**<br><br><br>DATE-TIME |
| **edit\_url**<br><br><br>STRING |
| **folder\_id**<br><br><br>STRING |
| **footer**<br><br><br>BOOLEAN |
| **href**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **is\_owner**<br><br><br>BOOLEAN |
| **language**<br><br><br>STRING |
| **nickname**<br><br><br>STRING |
| **page\_count**<br><br><br>INTEGER |
| **pages**<br><br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>description: STRING</li><li>href: STRING</li><li>id: STRING</li><li>position: INTEGER</li><li>question_count: INTEGER</li><li>questions: ARRAY, which is also a nested data structure.											<ul><li>answers: OBJECT, which is also a nested data structure.													<ul><li>choices: ARRAY, which is also a nested data structure.															<ul><li>description: STRING</li><li>id: STRING</li><li>image: OBJECT, which is also a nested data structure.																	<ul><li>s3_key: STRING</li><li>url: STRING</li></ul></li><li>is_na: BOOLEAN</li><li>position: INTEGER</li><li>quiz_options: OBJECT, which is also a nested data structure.																	<ul><li>score: INTEGER</li></ul></li><li>text: STRING</li><li>visible: BOOLEAN</li><li>weight: INTEGER</li></ul></li><li>cols: ARRAY, which is also a nested data structure.</li><li>other: OBJECT, which is also a nested data structure.</li><li>rows: ARRAY, which is also a nested data structure.</li></ul></li><li>display_options: OBJECT, which is also a nested data structure.													<ul><li>show_display_number: BOOLEAN</li></ul></li><li>family: STRING</li><li>forced_ranking: BOOLEAN</li><li>headings: ARRAY, which is also a nested data structure.													<ul><li>description: STRING</li><li>heading: STRING</li><li>image: OBJECT, which is also a nested data structure.															<ul><li>s3_key: STRING</li><li>url: STRING</li></ul></li><li>random_assignment: OBJECT, which is also a nested data structure.															<ul><li>description: STRING</li><li>id: STRING</li><li>percent: NUMBER</li><li>position: INTEGER</li><li>variable_name: STRING</li></ul></li></ul></li><li>href: STRING</li><li>id: STRING</li><li>layout: OBJECT, which is also a nested data structure.													<ul><li>bottom_spacing: NUMBER</li><li>col_width: NUMBER</li><li>col_width_format: STRING</li><li>left_spacing: NUMBER</li><li>num_chars: NUMBER</li><li>num_lines: NUMBER</li><li>position: STRING</li><li>right_spacing: NUMBER</li><li>top_spacing: NUMBER</li><li>width: NUMBER</li><li>width_format: STRING</li></ul></li><li>nickname: STRING</li><li>position: INTEGER</li><li>quiz_options: OBJECT, which is also a nested data structure.													<ul><li>feedback: OBJECT, which is also a nested data structure.															<ul><li>correct_text: STRING</li><li>incorrect_text: STRING</li><li>partial_text: STRING</li></ul></li><li>scoring_enabled: BOOLEAN</li></ul></li><li>required: OBJECT, which is also a nested data structure.													<ul><li>amount: STRING</li><li>text: STRING</li><li>type: STRING</li></ul></li><li>sorting: OBJECT, which is also a nested data structure.													<ul><li>ignore_last: BOOLEAN</li><li>type: STRING</li></ul></li><li>subtype: STRING</li><li>validation: OBJECT, which is also a nested data structure.													<ul><li>max: STRING</li><li>min: STRING</li><li>sum: INTEGER</li><li>sum_text: STRING</li><li>text: STRING</li><li>type: STRING</li></ul></li><li>visible: BOOLEAN</li></ul></li><li>title: STRING</li></ul> |
| **preview**<br><br><br>STRING |
| **question\_count**<br><br><br>INTEGER |
| **quiz\_options**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>feedback: OBJECT, which is also a nested data structure.											<ul><li>ranges: ARRAY, which is also a nested data structure.													<ul><li>max: STRING</li><li>message: STRING</li><li>min: STRING</li></ul></li><li>ranges_type: STRING</li></ul></li><li>is_quiz_mode: BOOLEAN</li><li>show_results_type: STRING</li></ul> |
| **response\_count**<br><br><br>INTEGER |
| **summary\_url**<br><br><br>STRING |
| **title**<br><br><br>STRING |

### surveys

This table contains information about your surveys.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | date\_modified |
| **Useful links** | [SurveyMonkey documentation](https://developer.surveymonkey.com/api/v3/) |

surveys table schema

| **date\_created**<br><br><br>DATE-TIME |
| --- |
| **date\_modified**<br><br><br>DATE-TIME |
| **id**<br><br><br>STRING |
| **language**<br><br><br>STRING |
| **nickname**<br><br><br>STRING |
| **question\_count**<br><br><br>INTEGER |
| **response\_count**<br><br><br>INTEGER |
| **title**<br><br><br>STRING |