Skip to main content
Version: v1.0.5

Reference Documentation

General reVISit​

  • GlobalConfig — The GlobalConfig is used to generate the list of available studies in the UI.

Data Formats​

  • ParticipantData – The ParticipantData is a JSON object that includes data for a participant in your study. This is how the data is stored in the database and how it will download with the JSON downloader.
  • StoredAnswer - The StoredAnswer object is a data structure describing the participants interaction with an individual component. It is used by ParticipantData to store individual answers.

reVISit Spec​

  • StudyConfig – The StudyConfig interface is used to define the properties of a study configuration. This is a JSON object with four main components: the StudyMetadata, the UIConfig, the Components, and the Sequence.
  • StudyMetadata – A top-level property of the StudyConfig. The study metadata defines elements such as the study title, authors, and description.
  • UIConfig – A top-level property of the StudyConfig, defining the appearance of the study.

For other components of the reVISit spec see Components and Sequencing

Components​

Components contain study-specific content. See the How does it Work guide for an introduction.

The different component types:

Responses​

Responses allow study designers to collect responses from participants Responses are included on administrative forms, such as consent or training, but most importantly as a response to a stimulus.

Form Elements​

Responses are provided as form elements. ReVISit supports the following form elements:

Sequencing​

Sequencing determines the order in which components appear.

  • ComponentBlock — The ComponentBlock interface is used to define order properties within the sequence.

Interruptions augment the sequence with components that are inserted either randomly or deterministically. These might be for breaks or attention checks.

Skip conditions enable the participant to jump through the sequence if a certain condition is met.