The connector only reads data. It never creates, changes or deletes anything in SurveyMonkey.
Configuring SurveyMonkey as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the SurveyMonkey option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
The connector signs in with the access token of a private app that you create in your own SurveyMonkey account. No app from Nekt is involved and SurveyMonkey does not need to review it.1
Create the app
Log in to developer.surveymonkey.com with the SurveyMonkey account whose surveys you want to sync, open My Apps and click Add a new app. Give the app a name. It starts as a draft app that can only read your own account.
2
Select the scopes
In the app’s Settings, under Scopes, set as required the read scopes of the tables you want to sync: View Surveys, View Collectors, View Response Details, View Contacts, View Users, View Webhooks and, on Team plans, View Teams, View Workgroups and View Workgroup Members. Save the settings.
3
Deploy and copy the access token
Deploy the app as a Private app (no review by SurveyMonkey is needed) and copy the Access Token shown in its Settings page. The token does not expire; if you revoke it or change the app, paste the new token in the source configuration.
- Access Token: The access token of your private app.
- Data Center: Where your SurveyMonkey account is hosted:
usif you log in at surveymonkey.com,eufor eu.surveymonkey.com,cafor surveymonkey.ca. - Start Date: The earliest date to read responses from, by the date each response was last modified. Survey design, collectors, contacts and teams are always read in full.
- Survey IDs (advanced): Comma-separated IDs of the surveys to read. Leave empty to read every survey the access token can see, including surveys shared with you.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.Tip: The stream can be found more easily by typing its name.Select the streams and click Next.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data, which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data, which is good if, for example, you don’t want to have deleted data in your catalog.
On Incremental, Responses and Response Answers read, per survey, only the responses created or changed since the previous sync (responses changed in the last 5 minutes are left to the next sync), and the survey design tables re-read only the surveys created or changed since the previous sync. The SurveyMonkey API does not report deletions: deleted responses, questions or answer options stay in incremental tables until a Full sync. When a response is edited, its answers are sent again with the new
response_date_modified; an answer row whose response_date_modified differs from the response’s date_modified was replaced by that edit. A Full sync reads every response again, which costs as many requests as the first sync and, on an account larger than the daily limit, completes over several days (see the limit above).4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Keep SurveyMonkey’s daily request limit in mind (see above). Optionally, you can define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while. It removes deleted responses and questions from incremental tables, at the cost of reading everything again.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Available streams
The table below lists every stream, its slug (the exact identifier to pass when creating the source via API), its sync type, the app scopes it needs and a short description.When your app was not granted the scope a table needs (or your SurveyMonkey plan does not include it), that table is skipped and not updated in that sync, the sync log names it and the scope to enable, and the other tables keep syncing. An invalid or revoked access token fails the sync. If SurveyMonkey refuses one survey (for example a survey shared with you without access to its results), or serves fewer of its responses than it announces even after a second read, that survey is skipped, the sync log names it, the other surveys are loaded, and the survey is tried again in the next sync. In tables replaced in full on every sync (Collectors, or a survey table you set to Full table), a refused survey’s rows are left out of the table. A survey whose responses cannot be read consistently makes a survey table set to Full table fail instead, so that table keeps its previous data rather than being saved with a gap. Nested information (custom variables, settings, quiz options) comes as JSON text.
Fields by stream
Surveys and design
Surveys
Surveys
Every survey the access token can see (owned and shared with the user), with current response and question counts.Table:
surveys · Primary key: id · Sync: Full table · Scopes: View Surveys.Survey Folders
Survey Folders
Folders that organize surveys.Table:
survey_folders · Primary key: id · Sync: Full table · Scopes: View Surveys.Survey Details
Survey Details
Settings of each survey: folder, category, ownership, quiz options, custom variables and links. Re-read only for surveys created or changed since the previous sync.Table:
survey_details · Primary key: id · Sync: Incremental by date_modified · Scopes: View Surveys.Survey Pages
Survey Pages
Pages of each survey. Re-read only for surveys created or changed since the previous sync.Table:
survey_pages · Primary key: survey_id, id · Sync: Incremental by survey_date_modified · Scopes: View Surveys.Survey Questions
Survey Questions
Questions of each survey, with type, text, validation and display settings. Re-read only for surveys created or changed since the previous sync.Table:
survey_questions · Primary key: survey_id, id · Sync: Incremental by survey_date_modified · Scopes: View Surveys.Survey Question Choices
Survey Question Choices
Every answer option of every question: choices, matrix rows and columns, choices inside matrix column menus and ‘other’ options. Their identifiers are the
choice_id, row_id, col_id and other_id of Response Answers.Table: survey_question_choices · Primary key: option_key · Sync: Incremental by survey_date_modified · Scopes: View Surveys.Responses and collectors
Responses
Responses
Survey responses with status, collector, respondent details, timing and custom variables. Each sync reads, per survey, the responses created or changed since the previous sync.Table:
responses · Primary key: id · Sync: Incremental by date_modified · Scopes: View Surveys and View Response Details (Basic plans: up to 25 responses per survey).Response Answers
Response Answers
One row per answer of a response: a selected choice, a matrix cell, a typed text or an uploaded file. Join with Survey Questions and Survey Question Choices to get the question and option texts.Table:
response_answers · Primary key: answer_key · Sync: Incremental by response_date_modified · Scopes: View Surveys and View Response Details.Collectors
Collectors
Collectors of every survey (web links, email invitations, SMS and others), with status and response count.Table:
collectors · Primary key: id · Sync: Full table · Scopes: View Surveys and View Collectors.Contacts
Contacts
Contacts
Contacts of the account in every status (active, opted out and bounced), with custom fields.Table:
contacts · Primary key: id · Sync: Full table · Scopes: View Contacts.Contact Lists
Contact Lists
Contact lists of the account.Table:
contact_lists · Primary key: id · Sync: Full table · Scopes: View Contacts.Contact List Members
Contact List Members
Which contact belongs to which contact list, in every status.Table:
contact_list_members · Primary key: contact_list_id, contact_id · Sync: Full table · Scopes: View Contacts.Contact Fields
Contact Fields
Labels of the custom contact fields (the keys of
contacts.custom_fields).Table: contact_fields · Primary key: id · Sync: Full table · Scopes: View Contacts.Account, teams and webhooks
Users
Users
The SurveyMonkey user the access token belongs to, with plan, features and scopes.Table:
users · Primary key: id · Sync: Full table · Scopes: View Users.Teams
Teams
Teams (groups) the user belongs to.Table:
groups · Primary key: id · Sync: Full table · Scopes: View Teams (Team plans).Team Members
Team Members
Members of each team, with role and status.Table:
group_members · Primary key: group_id, id · Sync: Full table · Scopes: View Teams (Team plans).Workgroups
Workgroups
Workgroups of the team, with members and shared resource counts.Table:
workgroups · Primary key: id · Sync: Full table · Scopes: View Workgroups (Team plans).Workgroup Members
Workgroup Members
Members of each workgroup.Table:
workgroup_members · Primary key: workgroup_id, id · Sync: Full table · Scopes: View Workgroups and View Workgroup Members (Team plans).Webhooks
Webhooks
Webhooks configured for the account. The authorization header SurveyMonkey sends with webhook events is never read into the table.Table:
webhooks · Primary key: id · Sync: Full table · Scopes: View Webhooks.