"SurveyMonkey" (Service Connection)
"SurveyMonkey" (Service Connection)
Connecting & Authenticating
ServiceConnect["SurveyMonkey"] creates a connection to the SurveyMonkey API.
Requests
ServiceExecute["SurveyMonkey","request",params] sends a request to the SurveyMonkey API, using parameters params. The following give possible requests.
Survey Results for Each Respondent
"SurveyResults" — retrieve questions and answers for a given survey
| "SurveyID" | (required) | the ID of the desired survey |
List of All Your Surveys
"SurveyList" — search surveys by date or other criteria
| MaxItems | 10 | number of elements to return | |
| "StartIndex" | 1 | start index | |
| "Fields" | None | fields to be included in the result | |
| "StartModifiedDate" | None | surveys modified after this date | |
| "EndModifiedDate" | None | surveys modified before this date | |
| "Title" | None | nickname of survey to search against |
Survey Details
"SurveyDetails" — retrieve a given survey's metadata.
| "SurveyID" | (required) | the ID of the desired survey |
List of All Your Collectors for a Survey
"CollectorList" — retrieve a paged list of collectors for a survey
| "SurveyID" | (required) | the ID of the desired survey | |
| MaxItems | 10 | number of elements to return | |
| "StartIndex" | 1 | start index | |
| "Fields" | None | fields to be included in the result | |
| "StartDate" | None | collectors started after this date | |
| "EndDate" | None | collectors ended before this date | |
| "Name" | None | nickname of collector to search against |
Status of Surveys in a Collector
"ResponseCounts" — returns how many respondents have started and/or completed the survey for the given collector
| "CollectorID" | (required) | the ID of the desired collector |
List of All Responses in a Survey
"SurveyResponseList" — retrieves a paged list of respondents for a given survey
| "SurveyID" | (required) | the ID of the desired survey | |
| MaxItems | 10 | number of elements to return | |
| "StartIndex" | 1 | start index | |
| "CollectorID" | None | the ID of a specific collector to filter results | |
| "StartModifiedDate" | None | respondents modified after this date | |
| "EndModifiedDate" | None | respondents modified before this date | |
| "SortBy" | None | column to sort results by |
List of All Responses in a Survey
"CollectorResponseList" — retrieves a paged list of respondents for a given collector
| MaxItems | 10 | number of elements to return | |
| "StartIndex" | 1 | start index | |
| "CollectorID" | (required) | the ID of a specific collector to filter results | |
| "StartDate" | None | collectors started after this date | |
| "EndDate" | None | collectors ended before this date | |
| "StartModifiedDate" | None | respondents modified after this date | |
| "EndModifiedDate" | None | respondents modified before this date | |
| "SortBy" | None | column to sort results by |
Survey Result IDs for a List of Respondents
"Response" — retrieves metadata of a response
| "SurveyID" | (required) | the ID of the desired survey | |
| "ResponseID" | (required) | list of "ResponseID" to retrieve |
User Data
"UserData" — returns basic information about the logged-in user
List of Templates
"TemplateList" — retrieves a paged list of templates provided by SurveyMonkey
| MaxItems | 10 | number of elements to return | |
| "StartIndex" | 1 | start index | |
| "Language" | None | language to filter templates with; accepts strings and language Entity | |
| "CategoryID" | None | category ID to filter templates with | |
| "AvailableToUser" | None | if set to True, filter templates to only show the ones available to the current user |
Create Weblink Collector
"CreateWeblinkCollector" — create a weblink used to collect survey responses
| "SurveyID" | (required) | the ID of the desired survey | |
| "Name" | None | optional name to give to the collector |
Parameter Details
| "Title" | survey name | |
| "DateCreated" | date survey was created | |
| "DateModified" | date survey was last modified | |
| "Language" | language of survey | |
| "QuestionCount" | number of questions in the survey | |
| "AnalysisURL" | URL to analysis page | |
| "PreviewURL" | URL to preview page |
| "URL" | URL for the collector | |
| "Open" | whether collector is open to collect responses | |
| "Type" | collector type | |
| "Name" | name of the collector | |
| "DateCreated" | date collector was created | |
| "DateModified" | date collector was last modified |