Public SurveyMonkey Connector API
BenchmarkBundles
List of benchmark bundles you have access to
Parameter
<country> (optional): Country to get the bundles for. Default is US
<id> (optional): Benchmark bundle id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Benchmark Bundle id |
title | string | Benchmark Bundle name |
details_bullets | string | Details bullets |
details_subtext | string | Details subtext |
Example
CREATE VIEW surveymonkey_examples.example_BenchmarkBundles AS
SELECT *
FROM (
CALL surveymonkey.BenchmarkBundles (
country => 'Germany'
)
) AS x
CollectorsId
Collector
Parameter
<id> (required): id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Collector id |
allow_multiple_responses | boolean | Allows respondents to take a survey more than once from the same browser on the same computer. Only available for collectors. |
anonymous_type | string | Turns off IP tracking. For email collectors, also removes respondent email address and name from response: 'not_anonymous', 'partially_anonymous', 'fully_anonymous' |
close_date | timestamp | Close date of collector |
closed_page_message | string | Message shown when someone visits a closed survey |
date_created | timestamp | Date collector was created |
date_modified | timestamp | Date collector was last modified |
display_survey_results | boolean | Shows respondents survey when they complete the survey |
disqualification_message | string | Message for disqualification page |
disqualification_type | string | Disqualification type |
disqualification_url | string | Disqualification_url |
edit_response_type | string | When respondents can edit their response: 'until_complete', 'never', or 'always' |
href | string | Resource API URL |
name | string | Name of the collector |
password_enabled | boolean | True if the collector is password protected |
redirect_type | string | Determines behavior: (redirects to URL set in or if none is set, shows standard SurveyMonkey thank you page), (closes the survey window or tab), or (loops the survey back to the beginning, only available for collectors with :true) |
redirect_url | string | Redirects respondent to this url upon survey completion |
response_count | integer | Response count |
response_limit | integer | Response limit |
sender_email | string | Sender email for email collectors. User's email is used if null |
status | string | Collector status: 'open' or 'closed' |
survey_id | string | ID of the survey the collector belongs to |
thank_you_message | string | Message for thank you page |
type | string | Collector type: 'weblink' or 'email' |
url | string | If collector is a Web Collector (type 'weblink') then the url for the collector |
Example
CREATE VIEW surveymonkey_examples.example_CollectorsId AS
SELECT *
FROM (
CALL surveymonkey.CollectorsId (
id => '228138117'
)
) AS x
CollectorsRecipients
List of recipients. Public App users need access to the View Collectors scope
Parameter
<id> (required): id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Recipient id |
string | Email of recipient added to collector | |
href | string | Resource API URL |
Example
CREATE VIEW surveymonkey_examples.example_CollectorsRecipients AS
SELECT *
FROM (
CALL surveymonkey.CollectorsRecipients (
id => '228138117'
)
) AS x
CollectorsResponses
List of responses. Public App users need access to the View Responses scope
Parameter
<id> (required): Collector's id
<custom> (optional): The custom value associated with the response
<email> (optional): Email of the recipient
<end_created_at> (optional): Responses started before this date
<end_modified_at> (optional): Responses modified before this date
<first_name> (optional): First Name of the recipient
<ip> (optional): The IP the response was taken from
<last_name> (optional): Last Name of the recipient
<start_created_at> (optional): Responses started after this date
<start_modified_at> (optional): Responses modified after this date
<total_time_max> (optional): The maximum amount of time spent on the response
<total_time_min> (optional): The minimum amount of time spent on the response
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Response id |
href | string | URL for the response resource |
Example
CREATE VIEW surveymonkey_examples.example_CollectorsResponses AS
SELECT *
FROM (
CALL surveymonkey.CollectorsResponses (
total_time_min => NULL,
total_time_max => NULL,
end_modified_at => NULL,
start_modified_at => NULL,
end_created_at => NULL,
start_created_at => NULL,
ip => NULL,
last_name => NULL,
first_name => NULL,
email => NULL,
custom => NULL,
id => '228138117'
)
) AS x
ContactFields
List of all custom contacts fields. Public App users need access to the View Contacts scope
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact id |
href | string | Resource API URL |
label | string | Contact Field Label |
Example
CREATE VIEW surveymonkey_examples.example_ContactFields AS
SELECT *
FROM (
CALL surveymonkey.ContactFields ()
) AS x
ContactFieldsId
Specified custom contact field. Public App users need access to the View Contacts scope
Parameter
<id> (required): id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact id |
href | string | href |
label | string | Yes |
Example
CREATE VIEW surveymonkey_examples.example_ContactFieldsId AS
SELECT *
FROM (
CALL surveymonkey.ContactFieldsId (
id => '1'
)
) AS x
ContactLists
All contact lists. Public App users need access to the View Contacts scope
Parameter
<id> (optional): id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact list id |
name | string | Contact list name |
Example
CREATE VIEW surveymonkey_examples.example_ContactLists AS
SELECT *
FROM (
CALL surveymonkey.ContactLists ()
) AS x
ContactListsContacts
All contacts in a contact list. Public App users need access to the View Contacts scope
Parameter
<id> (required): Contact's list id
<search> (optional): Query used to search
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact id |
first_name | string | Contact first name |
last_name | string | Contact last name |
string | Contact email address | |
href | string | Resource API URL |
Example
CREATE VIEW surveymonkey_examples.example_ContactListsContacts AS
SELECT *
FROM (
CALL surveymonkey.ContactListsContacts (
"search" => NULL,
id => '127464538'
)
) AS x
ContactListsContactsBulk
List of all contacts in the list with all available fields. Public App users need access to the View Contacts scope
Parameter
<id> (required): Contact's list id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact id |
first_name | string | Contact first name |
last_name | string | Contact last name |
string | Contact email address | |
href | string | Resource API URL |
custom_fields | string | Contact custom fields |
status | string | Status |
Example
CREATE VIEW surveymonkey_examples.example_ContactListsContactsBulk AS
SELECT *
FROM (
CALL surveymonkey.ContactListsContactsBulk (
id => '127464538'
)
) AS x
Contacts
List of all contacts. Public App users need access to the View Contacts scope
Parameter
<id> (optional): Contact's id
<search> (optional): Query used to search
<search_by> (optional): Field used to search returned contact list: email, first_name, last_name, 1, …, 6
<status> (optional): Filter by status (default=active): active, optout, or bounced
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact id |
first_name | string | Contact first name |
last_name | string | Contact last name |
string | Contact email address | |
href | string | Resource API URL |
custom_fields | string | Contact custom fields |
status | string | Status |
Example
CREATE VIEW surveymonkey_examples.example_Contacts AS
SELECT *
FROM (
CALL surveymonkey.Contacts (
search_by => 'email',
"search" => 'john' )
) AS x
Errors
List of known errors
Parameter
<id> (optional): id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Error id |
name | string | Error name |
docs | string | Error documentation page |
http_status_code | integer | http status code |
message | string | Error explanation |
Example
CREATE VIEW surveymonkey_examples.example_Errors AS
SELECT *
FROM (
CALL surveymonkey.Errors ()
) AS x
Groups
Team if the user account belongs to a team (users can only belong to one team). Public App users need access to the View Teams scope
Parameter
<id> (optional): Group's id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Group id |
name | string | Group name |
date_created | timestamp | Date and time when group was created |
max_invites | integer | Maximum number of members that can be in the group |
member_count | integer | Number of members in the group |
Example
CREATE VIEW surveymonkey_examples.example_Groups AS
SELECT *
FROM (
CALL surveymonkey.Groups ()
) AS x
GroupsMembers
List of users who have been added as members of the specified group. Public App users need access to the View Teams scope
Parameter
<id> (required): id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Member id |
href | string | Resource API URL |
username | string | Member username |
Example
CREATE VIEW surveymonkey_examples.example_GroupsMembers AS
SELECT *
FROM (
CALL surveymonkey.GroupsMembers (
id => 'Some value'
)
) AS x
QuestionBankQuestions
List of question bank questinos available to the user
Parameter
<search> (optional): Return only questions containing (or related to) this text
<custom> (optional): Whether to look through the regular Question Bank, or a Team's Custom Question Bank, defaults to
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
question_id | string | id of the question, to be used in creating it |
text | string | The text in the question |
modifiers | string | Modifiers that the question allows. e.g. ("this company", "this brand, "this product") (empty for Custom QB) |
locales | string | A list of locales that the question supports (empty for Custom QB) |
Example
CREATE VIEW surveymonkey_examples.example_QuestionBankQuestions AS
SELECT *
FROM (
CALL surveymonkey.QuestionBankQuestions (
"search" => NULL,
custom => NULL
)
) AS x
SurveyCategories
List of survey categories that can be used to filter survey templates. Public App users need access to the View Library Assets scope
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Resource id |
name | string | Resource name |
Example
CREATE VIEW surveymonkey_examples.example_SurveyCategories AS
SELECT *
FROM (
CALL surveymonkey.SurveyCategories ()
) AS x
SurveyFolders
Available folders
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | id |
href | string | href |
num_surveys | integer | num surveys |
title | string | title |
Example
CREATE VIEW surveymonkey_examples.example_SurveyFolders AS
SELECT *
FROM (
CALL surveymonkey.SurveyFolders ()
) AS x
SurveyLanguages
List of survey languages that can be used to generate translations for multilingual surveys
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Language code |
name | string | Name of language |
native_name | string | Name of language in native language |
Example
CREATE VIEW surveymonkey_examples.example_SurveyLanguages AS
SELECT *
FROM (
CALL surveymonkey.SurveyLanguages ()
) AS x
SurveyTemplates
List of survey templates. Survey template ids can be used as an argument to POST a new survey. Public App users need access to the View Library Assets scope
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Resource id |
available | boolean | Template is available to user |
category | string | Template category |
description | string | Template description |
name | string | Resource name |
num_questions | integer | Number of questions in the template |
preview_link | string | Template preview URL |
title | string | Survey title |
Example
CREATE VIEW surveymonkey_examples.example_SurveyTemplates AS
SELECT *
FROM (
CALL surveymonkey.SurveyTemplates ()
) AS x
Surveys
List of surveys owned or shared with the authenticated user. Public App users need access to the View Surveys scope
Parameter
<id> (optional): Survey's id
<end_modified_at> (optional): Surveys must be last modified before this date
<folder_id> (optional): Specify the id of a folder to only return surveys in it
<start_modified_at> (optional): Surveys must be last modified after this date
<title> (optional): Search survey list by survey title
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Survey id |
nickname | string | Survey nickname |
title | string | Survey title |
analyze_url | string | Survey analyze URL |
buttons_text_done_button | string | Button text |
buttons_text_exit_button | string | Button text |
buttons_text_next_button | string | Button text |
buttons_text_prev_button | string | Button text |
category | string | Survey category chosen when creating the survey |
collect_url | string | Survey collect URL |
custom_variables_name | string | Survey collect |
date_created | timestamp | Date and time when survey was created |
date_modified | timestamp | Date and time when survey was last modified |
edit_url | string | Survey edit URL |
folder_id | string | If applicable, the id of the folder the survey is in |
footer | boolean | Whether or not SurveyMonkey's footer is not displayed |
href | string | Resource API URL |
is_owner | string | Is owner |
language | string | ISO 639-1 code for survey language |
page_count | integer | Number of pages in survey |
preview | string | Survey preview URL |
question_count | integer | Number of questions in survey |
quiz_options_feedback_ranges_type | string | Quiz options feedback ranges type |
quiz_options_is_quiz_mode | string | Quiz options is quiz mode |
quiz_options_show_results_type | string | Quiz options show results type |
response_count | integer | Number of responses survey has received |
summary_url | string | Survey summary URL |
Example
CREATE VIEW surveymonkey_examples.example_Surveys AS
SELECT *
FROM (
CALL surveymonkey.Surveys (
title => NULL,
end_modified_at => NULL,
start_modified_at => NULL,
folder_id => NULL
)
) AS x
SurveysCollectors
List of collectors for a given survey. Public App users need access to the View Collectors scope
Parameter
<id> (required): Survey's id
<end_date> (optional): Collectors must be created before this date.
<name> (optional): Nickname of collector to search against
<start_date> (optional): Collectors must be created after this date.
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Collector id |
date_created | timestamp | Date collector was created |
date_modified | timestamp | Date collector was last modified |
href | string | Resource URL |
name | string | Collector name |
response_count | string | response count |
status | string | Collector status: 'open' or 'closed' |
type | string | Collector type: 'weblink' or 'email' |
url | string | If collector is a Web Collector (type 'weblink') then the url for the collector |
Example
CREATE VIEW surveymonkey_examples.example_SurveysCollectors AS
SELECT *
FROM (
CALL surveymonkey.SurveysCollectors (
end_date => NULL,
start_date => NULL,
name => NULL,
id => '169445302'
)
) AS x
SurveysDetails
An expanded survey resource with a pages element containing a list of all page objects, each containing a list of questions objects. Public App users need access to the View Surveys scope
Parameter
<id> (optional): id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Survey id |
analyze_url | string | Survey analyze URL |
buttons_text_done_button | string | Button text |
buttons_text_exit_button | string | Button text |
buttons_text_next_button | string | Button text |
buttons_text_prev_button | string | Button text |
category | string | Survey category chosen when creating the survey |
collect_url | string | Survey collect URL |
custom_variables | string | Dictionary of survey variables |
date_created | timestamp | Date and time when survey was created |
date_modified | timestamp | Date and time when survey was last modified |
edit_url | string | Survey edit URL |
folder_id | string | If applicable, the id of the folder the survey is in |
footer | boolean | Whether or not SurveyMonkey's footer is not displayed |
href | string | Resource API URL |
is_owner | string | Is owner |
language | string | ISO 639-1 code for survey language |
nickname | string | Survey nickname |
page_count | integer | Number of pages in survey |
preview | string | Survey preview URL |
question_count | integer | Number of questions in survey |
quiz_options_feedback_ranges_type | string | quiz options feedback ranges type |
quiz_options_is_quiz_mode | string | quiz options is quiz mode |
quiz_options_show_results_type | string | quiz options show results type |
response_count | integer | Number of responses survey has received |
summary_url | string | Survey summary URL |
title | string | Survey title |
Example
CREATE VIEW surveymonkey_examples.example_SurveysDetails AS
SELECT *
FROM (
CALL surveymonkey.SurveysDetails (
id => '169445302'
)
) AS x
SurveysLanguages
All existing translations
Parameter
<survey_id> (required): Survey's id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Language code for the translation |
enabled | boolean | If True, translation is available for respondents to select |
href | string | Resource URL |
inherited_string_count | integer | Count of strings that have empty but have a parent translation with an existing they can fall back to |
name | string | The name of the language in English |
native_name | string | The name of the language in the language itself |
stale_string_count | integer | Count of strings that have been updated in the source language since the translation was last updated |
string_count | integer | Count of strings in the survey |
translated_string_count | integer | Count strings that have |
Example
CREATE VIEW surveymonkey_examples.example_SurveysLanguages AS
SELECT *
FROM (
CALL surveymonkey.SurveysLanguages (
survey_id => '169445302'
)
) AS x
SurveysPages
Page's details. Public App users need access to the View Surveys scope
Parameter
<id> (required): id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Page ID |
description | string | Page Description |
href | string | Resource API URL |
position | integer | Position of page in survey |
title | string | Page Title |
Example
CREATE VIEW surveymonkey_examples.example_SurveysPages AS
SELECT *
FROM (
CALL surveymonkey.SurveysPages (
id => '169445302'
)
) AS x
SurveysResponsesBulk
List of full expanded responses, including answers to all questions. Public App users need access to the View Response Details scope
Parameter
<id> (required): Survey's id
<custom> (optional): The custom value associated with the response
<email> (optional): Email of the recipient
<end_created_at> (optional): Responses started before this date
<end_modified_at> (optional): Responses modified before this date
<first_name> (optional): First Name of the recipient
<ip> (optional): The IP the response was taken from
<last_name> (optional): Last Name of the recipient
<start_created_at> (optional): Responses started after this date
<start_modified_at> (optional): Responses modified after this date
<total_time_max> (optional): The maximum amount of time spent on the response
<total_time_min> (optional): The minimum amount of time spent on the response
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Response id |
analyze_url | string | Weblink to the analyze page to view the response |
collection_mode | string | The collection mode of the response: default, preview, data_entry, survey_preview, or edit |
collector_id | string | ID of the collector the response was taken for |
custom_value | string | Custom value associated with a response |
custom_variables | string | Values to any available custom variables in the survey |
date_created | timestamp | Date the response was created |
date_modified | timestamp | Date the response was last modified |
edit_url | string | Weblink to the survey taking page to edit the response |
ip_address | string | IP Address the response was taken from |
logic_path | string | Logic path |
metadata_contact_email_type | string | metadata contact email type |
metadata_contact_email_value | string | metadata contact email value |
page_path | string | page path |
quiz_results_correct | string | quiz results correct |
quiz_results_incorrect | string | quiz results incorrect |
quiz_results_partially_correct | string | quiz results partially correct |
quiz_results_score | string | quiz results score |
quiz_results_total_questions | string | quiz results total questions |
quiz_results_total_score | string | quiz results total score |
recipient_id | string | ID of the recipient (only for email collectors). |
response_status | string | Status of the response: completed, partial, overquota, or disqualified |
survey_id | string | ID of the survey the response was taken for |
total_time | integer | Total time in seconds spent on the survey |
page_id | string | page id |
question_id | string | question id |
choice_id | integer | The choice selected |
is_correct | string | Is correct |
other_id | integer | The other text choice selected |
row_id | integer | The row selected |
score | string | The score |
text | string | Any open ended text |
Example
CREATE VIEW surveymonkey_examples.example_SurveysResponsesBulk AS
SELECT *
FROM (
CALL surveymonkey.SurveysResponsesBulk (
total_time_min => NULL,
total_time_max => NULL,
end_modified_at => NULL,
start_modified_at => NULL,
end_created_at => NULL,
start_created_at => NULL,
ip => NULL,
last_name => NULL,
first_name => NULL,
email => NULL,
custom => NULL,
id => '169445302'
)
) AS x
SurveysRollups
Rollups for all questions in a survey. Public App users need access to the View Response Details scope
Parameter
<id> (required): Survey's id
<custom> (optional): Limits responses to those associated with specified value for
<email> (optional): Limits responses to those associated with specified email address
<end_created_at> (optional): Limits responses to those created before date specified
<end_modified_at> (optional): Limits responses to those last modified before date specified
<first_name> (optional): Limits responses to those associated with specified first name
<ip> (optional): Limits responses to those associated with specified IP address
<last_name> (optional): Limits responses to those associated with specified last name
<start_created_at> (optional): Limits responses to those created after date specified
<start_modified_at> (optional): Limits responses to those last modified after date specified
<total_time_max> (optional): Limits responses to those that took respondents less time to complete than specified time
<total_time_min> (optional): Limits responses to those that took respondents more time to complete than specified time
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Question identifier |
family | string | Question family. |
subtype | string | Question subtype. |
part | string | Part |
choices | string | Returns question's choices with the id and count for each choice |
answered | integer | Returns the count of respondents who answered the question |
count | integer | Count |
max | integer | Mmax |
other_answered | integer | Returns the count of responses who answered the other choice, if available |
question_id | string | Question id |
skipped | integer | Returns the count of respondents who skipped the question |
stats_max | string | Returns for close ended questions |
stats_mean | string | Returns for close ended questions |
stats_median | string | Returns for close ended questions |
stats_min | string | Returns for close ended questions |
stats_std | string | Returns for close ended questions |
text | string | Text |
total | string | Total |
Example
CREATE VIEW surveymonkey_examples.example_SurveysRollups AS
SELECT *
FROM (
CALL surveymonkey.SurveysRollups (
total_time_min => NULL,
total_time_max => NULL,
end_modified_at => NULL,
start_modified_at => NULL,
end_created_at => NULL,
start_created_at => NULL,
ip => NULL,
id => '169445302',
last_name => NULL,
first_name => NULL,
email => NULL,
custom => NULL
)
) AS x
SurveysTrends
Answer counts for a particular time periods. Public App users need access to the View Response Details scope
Parameter
<id> (required): Survey's id
<first_respondent> (optional): Limits responses to those completed after the specified respondent id
<last_respondnet> (optional): Limits responses to those completed before the specified respondent id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type |
---|---|
id | string |
family | string |
subtype | string |
answered | integer |
skipped | integer |
trend_by | string |
part | string |
start | string |
end | string |
choices | string |
count | integer |
max | integer |
question_id | string |
total | string |
Example
CREATE VIEW surveymonkey_examples.example_SurveysTrends AS
SELECT *
FROM (
CALL surveymonkey.SurveysTrends (
last_respondnet => NULL,
id => '169445302',
first_respondent => NULL
)
) AS x
UsersMe
Current user's account details including their plan. Public App users need access to the View Users scope
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | User id |
string | Email address for user's account | |
first_name | string | User's first name |
last_name | string | User's last name |
account_type | string | the user has |
date_created | string | Date user's account was created |
date_last_login | timestamp | Date user last logged in |
email_verified | boolean | Email address for user's account has been verified |
href | string | href |
language | string | ISO 639-1 code for the language set for the user's account |
scopes_available | string | Scopes available |
scopes_granted | string | Scopes granted |
username | string | Username |
Example
CREATE VIEW surveymonkey_examples.example_UsersMe AS
SELECT *
FROM (
CALL surveymonkey.UsersMe ()
) AS x
Webhooks
List of webhooks. Public App users need access to the View Webhooks scope
Parameter
<id> (optional): Webhook's id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Webhook id |
event_type | string | Event type |
name | string | Webhook name |
object_ids | string | Object ids |
object_type | string | Object type |
subscription_url | string | Subscription url |
Example
CREATE VIEW surveymonkey_examples.example_Webhooks AS
SELECT *
FROM (
CALL surveymonkey.Webhooks ()
) AS x
Workgroups
Workgroups the user can see in an organization. Public App users need access to the View Workgroups scope
Parameter
<id> (optional): Workgroup's id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | ID of the workgroup |
created_at | timestamp | Datetime when the workgroup was created |
default_role_description | string | Default role description |
default_role_id | string | Default role id |
default_role_is_enabled | string | Default role is enabled |
default_role_metadata | string | Default role metadata |
default_role_name | string | Default role name |
description | string | Description of the workgroup |
is_visible | boolean | Whether the workgroup is publicly visible or only visible to its members and administrators |
members | string | The active members of the workgroup. |
metadata | string | Metadata |
name | string | Name of the workgroup |
shares | string | Shares |
shares_count | integer | Number of resources shared with the workgroup |
updated_at | timestamp | Datetime when the workgroup was last updated |
Example
CREATE VIEW surveymonkey_examples.example_Workgroups AS
SELECT *
FROM (
CALL surveymonkey.Workgroups ()
) AS x
WorkgroupsMembers
Members in a workgroup. Public App users need access to the View Workgroup Members scope
Parameter
<workgroup_id> (required): Workgroup's id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | The user ID of the member |
created_at | timestamp | Datetime when the member was created |
is_workgroup_owner | boolean | Whether the member is an owner of the workgroup |
role_assignment_id | string | An ID referencing the assigned role of the member |
status | string | The status of the member, either "active" or "pending" |
updated_at | timestamp | Datetime when the member was last updated |
workgroup_id | string | ID of the member's workgroup |
Example
CREATE VIEW surveymonkey_examples.example_WorkgroupsMembers AS
SELECT *
FROM (
CALL surveymonkey.WorkgroupsMembers (
workgroup_id => '71d9d408d1914c9ca85ffcda8330d675'
)
) AS x
WorkgroupsShares
Resources shared in a workgroup. Public App users need access to the View Workgroup Shares scope
Parameter
<workgroup_id> (required): Workgroup's id
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | ID of the share record |
created_at | timestamp | Datetime when the resource was shared |
organization_id | string | ID of the user's organization (Team ID) |
owner_user_id | string | The ID of the user who shared the resource |
resource_id | string | The ID of the shared resource (e.g. the ID of a survey) |
resource_type | string | The type of the shared resource |
workgroup_id | string | D of the workgroup that was shared with |
Example
CREATE VIEW surveymonkey_examples.example_WorkgroupsShares AS
SELECT *
FROM (
CALL surveymonkey.WorkgroupsShares (
workgroup_id => '71d9d408d1914c9ca85ffcda8330d675'
)
) AS x