suso_get_stats: Survey Solutions API call for Summary Tables

View source: R/suso_api_statistics.R

suso_get_statsR Documentation

Survey Solutions API call for Summary Tables

Description

Returns summary tables for individual questions. If no responses had been provided, an empty table will be returned

Usage

suso_get_stats(
  server = suso_get_api_key("susoServer"),
  apiUser = suso_get_api_key("susoUser"),
  apiPass = suso_get_api_key("susoPass"),
  workspace = NULL,
  token = NULL,
  questID = "",
  version = "",
  qQuest = "",
  byTeam = TRUE
)

Arguments

server

Survey Solutions server address

apiUser

Survey Solutions API user

apiPass

Survey Solutions API password

workspace

server workspace, if nothing provided, defaults to primary

token

If Survey Solutions server token is provided apiUser and apiPass will be ignored

questID

only assignments for QuestionnaireId are returned, requires version being not NULL

version

version of the questionnaire, only required with questID

qQuest

provide QuestionnaireId and version to receive all questions and responses for a specific questionnaire

byTeam

should the table contain reports by team


michael-cw/SurveySolutionsAPI documentation built on Jan. 14, 2024, 2:58 a.m.