Rmonkey (version 0.3.1)

surveylist: Get survey list

Description

Get the list of the user's survey

Usage

surveylist(page = NULL, page_size = NULL, start_date = NULL, end_date = NULL, title = NULL, recipient_email = NULL, order_asc = NULL, fields = NULL, api_key = getOption('sm_api_key'), oauth_token = getOption('sm_oauth_token'), ...)

Arguments

page

A number indicating which page of results to return.

page_size

The number of results to return per API call. Default is 1000.

start_date

A start datetime to restrict result to. Any returned surveys must have been created on or after this datetime. Required format is YYYY-MM-DD HH:MM:SS, implicitly in UTC; if argument is of class POSIXct, formatting is handled automatically.

end_date

An end datetime to restrict result to. Any returned surveys must have been created strictly before this datetime. Required format is YYYY-MM-DD HH:MM:SS, implicitly in UTC; if argument is of class POSIXct, formatting is handled automatically.

title

A character string containing the title of a survey to search for.

recipient_email

A character string containing an email adddress. Only surveys sent to this email will be returned.

order_asc

A boolean indicating whether results should be sorted in ascending or descending (the default) order.

fields

A character vector containing the names of fields to return in each sm_collector class object. See Details.

api_key

Your API key. By default, retrieved from getOption('sm_api_key').

oauth_token

Your OAuth 2.0 token, as generated by smlogin. By default, retrieved from getOption('sm_oauth_token').

...

Other arguments passed to POST.

Value

sm_survey.

Details

Retrieves the list of surveys available to the user.

The fields argument accepts one or more of the following values: title, analysis_url, preview_url, date_created, date_modified, language_id, question_count, num_responses.

References

https://developer.surveymonkey.com/mashery/get_survey_list

Examples

## Not run: 
# smlogin()
# surveylist()
# ## End(Not run)