get_interviews: Get interviews

In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

Get interviews

Description

Get list of interviews and their attributes

Usage

get_interviews(
  nodes = c("id", "key", "assignmentId", "identifyingData", "questionnaireId",
    "questionnaireVersion", "questionnaireVariable", "responsibleName", "responsibleId",
    "responsibleRole", "supervisorName", "status", "actionFlags", "wasCompleted",
    "notAnsweredCount", "errorsCount", "createdDate", "updateDateUtc",
    "receivedByInterviewerAtUtc", "interviewMode"),
  chunk_size = 100,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

nodes	Character vector. Names of attributes to fetch for each interview.
chunk_size	Numeric. Number of records to take in one request.
server	Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Name of the workspace whose interviews to get. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.
user	Character. API or admin user name for user that access to the workspace.
password	Character. API or admin password

Details

GraphQL implementation of deprecated REST ⁠GET ​/api​/v1​/interviews​/{id}⁠ endpoint.

Value

Data frame of interviews and their (user-specified) attributes.

arthur-shaw/susoapi documentation built on Oct. 15, 2024, 3:44 a.m.