Get survey summary, regarding token usage and survey participation

lsGetSummary(
  surveyID,
  status = "all",
  lsAPIurl = getOption("lsAPIurl"),
  sessionKey = NULL
)

Arguments

surveyID

ID of the survey

status

(optional) To request a specific status ("completed_responses", "incomplete_responses", "full_responses", "token_count", "token_invalid", "token_sent", "token_opted_out", "token_completed", "token_screenout") as string or "all" as a list

lsAPIurl

(optional) The URL of the LimeSurvey RemoteControl 2 JSON-RPC API

sessionKey

(optional) Authentication token, see lsGetSessionKey

Value

A string if status is provided and not "all", otherwise a list containing all available values

References

https://api.limesurvey.org/classes/remotecontrol_handle.html#method_get_summary

Examples

if (FALSE) { lsGetSummary("123456") }