"SurveyMonkey" (Service Connection)

Connect to the SurveyMonkey API using the Wolfram Language to retrieve survey details and analyze responses.

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

Request:

"SurveyResults" retrieve questions and answers for a given survey

Parameters:
  • "SurveyID"(required)the ID of the desired survey
  • List of All Your Surveys

    Request:

    "SurveyList" search surveys by date or other criteria

    Parameters:
  • MaxItems10number of elements to return
    "StartIndex"1start index
    "Fields"Nonefields to be included in the result
    "StartModifiedDate"Nonesurveys modified after this date
    "EndModifiedDate"Nonesurveys modified before this date
    "Title"Nonenickname of survey to search against
  • Survey Details

    Request:

    "SurveyDetails" retrieve a given survey's metadata.

    Parameters:
  • "SurveyID"(required)the ID of the desired survey
  • List of All Your Collectors for a Survey

    Request:

    "CollectorList" retrieve a paged list of collectors for a survey

    Parameters:
  • "SurveyID"(required)the ID of the desired survey
    MaxItems10number of elements to return
    "StartIndex"1start index
    "Fields"Nonefields to be included in the result
    "StartDate"Nonecollectors started after this date
    "EndDate"Nonecollectors ended before this date
    "Name"Nonenickname of collector to search against
  • Status of Surveys in a Collector

    Request:

    "ResponseCounts" returns how many respondents have started and/or completed the survey for the given collector

    Parameters:
  • "CollectorID"(required)the ID of the desired collector
  • List of All Responses in a Survey

    Request:

    "SurveyResponseList" retrieves a paged list of respondents for a given survey

    Parameters:
  • "SurveyID"(required)the ID of the desired survey
    MaxItems10number of elements to return
    "StartIndex"1start index
    "CollectorID"Nonethe ID of a specific collector to filter results
    "StartModifiedDate"Nonerespondents modified after this date
    "EndModifiedDate"Nonerespondents modified before this date
    "SortBy"Nonecolumn to sort results by
  • List of All Responses in a Survey

    Request:

    "CollectorResponseList" retrieves a paged list of respondents for a given collector

    Parameters:
  • MaxItems10number of elements to return
    "StartIndex"1start index
    "CollectorID"(required)the ID of a specific collector to filter results
    "StartDate"Nonecollectors started after this date
    "EndDate"Nonecollectors ended before this date
    "StartModifiedDate"Nonerespondents modified after this date
    "EndModifiedDate"Nonerespondents modified before this date
    "SortBy"Nonecolumn to sort results by
  • Survey Result IDs for a List of Respondents

    Request:

    "Response" retrieves metadata of a response

    Parameters:
  • "SurveyID"(required)the ID of the desired survey
    "ResponseID"(required)list of "ResponseID" to retrieve
  • User Data

    Request:

    "UserData" returns basic information about the logged-in user

    List of Templates

    Request:

    "TemplateList" retrieves a paged list of templates provided by SurveyMonkey

    Parameters:
  • MaxItems10number of elements to return
    "StartIndex"1start index
    "Language"Nonelanguage to filter templates with; accepts strings and language Entity
    "CategoryID"Nonecategory ID to filter templates with
    "AvailableToUser"Noneif set to True, filter templates to only show the ones available to the current user
  • Create Weblink Collector

    Request:

    "CreateWeblinkCollector" create a weblink used to collect survey responses

    Parameters:
  • "SurveyID"(required)the ID of the desired survey
    "Name"Noneoptional name to give to the collector
  • Parameter Details

    Possible values for "Fields" in the request "SurveyList" include:
  • "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
  • Possible values for "Fields" in the request "CollectorList" include:
  • "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
  • Examples

    Basic Examples  (1)

    Create a new connection:

    Retrieve a list of surveys:

    Sort by field and show the top 5:

    Show survey details:

    Retrieve results for a specific "SurveyID":

    Select answers by "ResponseID":

    Extract answers to a given question:

    Get information about survey responses:

    Get a list of available templates:

    Retrieve results for a given survey:

    Collect the responses to a question:

    Tally and plot the results:

    Introduced in 2016
     (10.4)