get_interview_stats: Get statistics by interview

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

Get statistics by interview

Description

Fetch statistics for a single interview.

Usage

get_interview_stats(
  interview_id,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

interview_id	Character. Interview ID. GUID from server or interview__id from exported data
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 user name
password	Character. API password

Details

These statistics provide metadata about the interview process. Columns include: Answered, NotAnswered, Flagged, NotFlagged, Valid, Invalid, WithComments, ForInterviewer, ForSupervisor, InterviewId, InterviewKey, Status, ResponsibleId, ResponsibleName, NumberOfInterviewers, NumberRejectionsBySupervisor, NumberRejectionsByHq, InterviewDuration, AssignmentId, UpdatedAtUtc.

Wrapper for GET /api/v1/interviews/{id}/stats endpoint

Value

Data frame with all values provided by the server.

arthur-shaw/susoapi documentation built on Feb. 10, 2023, 7:47 p.m.