get_survey: Get Information on a Qualtrics Survey

View source: R/get_survey.R

get_surveyR Documentation

Get Information on a Qualtrics Survey

Description

Retrieve a JSON object that has information on a given survey. There are currently three different api calls that can be specified by the type argument:

  • survey gives the structure of the survey in a similar but not identical format as downloading the metadata

  • definitions contains information about the survey's body such as the flow, blocks, questions ect.

  • metadata holds information about survey settings such as the name and status

Usage

get_survey(survey_id, type = c("survey", "definitions", "metadata"))

Arguments

survey_id

string of the survey id, begins with 'SV_'

type

specify which API call to perform

Value

a list containing the results of the API call

Author(s)

Sven Halvorson (svenpubmail@gmail.com)

See Also

API call references:


svenhalvorson/qualtreats documentation built on May 3, 2024, 9:33 a.m.