get_recipients: get_recipients

View source: R/recipients.R

get_recipientsR Documentation

get_recipients

Description

Get recipients for a SurveyMonkey collector. Only valid when recipients are contacted via SurveyMonkey (e.g., sending a survey invitation from SurveyMonkey).

Usage

get_recipients(
  collector_id,
  page = 1,
  per_page = 50,
  all_pages = TRUE,
  oauth_token = get_token()
)

Arguments

collector_id

the collector whose responses you want, find this value with get_collectors.

page

Integer to select which page of resources to return. By default is 1.

per_page

How many recipients per page? Default is 50, which appears to be the maximum.

all_pages

return all pages of respondents? Default is TRUE, which will fetch all responses (and cause n/50 calls to the API).

oauth_token

Your OAuth 2.0 token. By default, retrieved from get_token().

Value

a data.frame (technically a tibble) with each collector and its information.


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