get_responses: get_responses

In sfirke/surveymonkey: Fetch survey results from the SurveyMonkey API and turn them into tidy data.frames

get_responses

Description

Get responses for a SurveyMonkey survey

Usage

get_responses(
  id,
  page = 1,
  all_pages = TRUE,
  per_page = 100,
  start_created_at = NULL,
  end_created_at = NULL,
  start_modified_at = NULL,
  end_modified_at = NULL,
  sort_order = "DESC",
  sort_by = "date_modified",
  oauth_token = get_token()
)

Arguments

id	The survey's ID, can be found with browse_survey().
page	Integer number to select which page of resources to return. By default is 1.
all_pages	return all pages of respondents? Default is TRUE, which will fetch all responses (and cause n/100 calls to the API).
per_page	Integer number to set the number of surveys to return per page. By default, is 100 surveys per page (appears to be the maximum allowed by the API).
start_created_at	Date string used to select surveys created after this date. By default is NULL.
end_created_at	Date string used to select surveys modified before this date. By default is NULL.
start_modified_at	Date string used to select surveys last modified after this date. By default is NULL.
end_modified_at	Date string used to select surveys modified before this date. By default is NULL.
sort_order	String used to set the sort order for returned surveys: 'ASC’ or 'DESC’. By default, DESC.
sort_by	String value of field used to sort returned survey list: ‘title’, 'date_modified’, or 'num_responses’. By default, date_modified.
oauth_token	Your OAuth 2.0 token. By default, retrieved from get_token().

Value

A list of object of class sm_response

References

SurveyMonkey API V3 at https://developer.surveymonkey.com/api/v3/#survey-responses

sfirke/surveymonkey documentation built on Oct. 14, 2022, 6:18 a.m.