labvanced logoLabVanced
Contact
    • Remote Physiological Measurements
    • Eye Tracking
    • Head & Face-Tracking
    • Emotion Detection
    • Heart Rate Detection (rPPG)
    • Generative AI
    • Audio Transcription
    • EEG & Hardware Integrations
    • Decision Making
    • Reaction Times
    • Keyboard Inputs
    • Mouse Tracking
    • Mobile / Touch
    • Questionnaires
    • Gamepad / Joystick Integration
    • Audio Recordings
    • Audio Transcription
    • Video Recordings
    • Screen Recordings
    • Photos / Snapshots
    • Video Conferencing
    • Canvas Drawings
    • Build with AI
    • Build with Spreadsheets
    • Using the Experiment Editor
    • Coding
    • Creating Questionnaires
    • Balancing & Randomization
    • UX & Website Testing
    • Single Session Studies
    • Factorial Designs
    • Longitudinal & Multi-session Studies
    • Individual & Case Studies
    • Real-time Multi-user Studies
    • Interviews & Video Calls
    • Surveys & Questionnaires
    • Experience Sampling & Diaries
    • Classroom & Group Testing
    • Interventions & Clinical Trials
    • In the Browser
    • Mobile App
    • Desktop App
    • WebBridge Chrome Extension
    • Stroop Test
    • Flanker Task
    • N-back Task
    • Implicit Association Test
    • Trail Making Test
    • Digit Span
    • Corsi Block Tapping
    • Tower of London
    • Balloon Analog Risk Task
    • Preferential Looking
    • Browse more →
    • DASS-21
    • GAD-7
    • Rosenberg Self-Esteem Scale
    • PHQ-9
    • Ten-Item Personality Inventory
    • Big Five Personality Test
    • Adult ADHD Self-Report Scale
    • Browse more →
    • Building a Multi-user Study
    • Webcam Eye Tracking with AOIs
    • Website Frame Eye Tracking
    • Conditional Eye Tracking Opt-in
    • ChatGPT Study
    • Desktop App Study with EEG
    • Between-subjects Group Balancing
    • Building a Reading Study
    • Stroop Task
    • Lexical Decision Task
    • Browse more →
    Public Experiment Library
    • Arts Research
    • Clinical Psychology & Neuropsychology Medicine
    • Cognitive Psychology
    • Developmental Psychology
    • Behavioral Economics & Decision Science
    • Educational Research & Psychology
    • HCI & Human Factors
    • Linguistics & Language Sciences
    • Consumer & Marketing Research
    • Social & Personality Psychology
    • Sport & Movement Science
    • UX & Website Testing
    • Executive Functions
    • Language & Reading
    • Decision-Making & Reasoning
    • Attention
    • Overview
    • HCI & Human Factors
    • UX & Website Testing
    • Consumer & Marketing Research
    • White-Label App
    • PageGazer
    • Webcam vs. Lab Eye Tracking in InfantsAnna Banki & Gabriela Markova
    • Eye Tracking for Influencer MarketingDr. Alexander Edeling
    • Eye Tracking Infant Word ComprehensionDr. Giulia Calignano
    • Sentence Reading and Grammar JudgmentsDr. Jonathan Mirault
    • Regulating Emotions with MusicDr. Katrin Starcke
    • Game-Based Grammar Learning in ChildrenDr. Mireia Marimon
    • Gaze Cueing and AutismMax Soares Miehstein
    • Personality and Hearing in NoiseDr. Malte Wöstmann
    • All interviews →
    • Lab Notes
    • How to Cite Labvanced
    • Labvanced Platform Paper (2017)
    • Webcam Eye Tracking Validation (2024)
    • Webcam Eye Tracking Studies
    • Cognitive Psychology Studies
    • Developmental Psychology Studies
    • Linguistics Studies
    • See all publications →
    • Getting Started
    • Guide
    • Video Tutorials
    • Walkthroughs
    • Live Chat
    • Webinars & Onboarding Calls
    • AI Assistant
    • FAQ
    • Importing Templates Guide
    • Test Templates
    • Live Eye Tracking Metrics
    • Mouse Tracking Demo
    • ChatGPT Demo
    • Audio Recording Object Demo
    • Adding Image Stimuli Demo
    • Score & Feedback Demo
    • Browse all technical demos →
    • Timing Precision
    • Stimuli Presentation
    • Headphone Checks
    • Bot Checks
    • Participant Management
    • Comparisons
    • Research Blog
    • Prolific Integration
    • CloudResearch Integration
    • Sona Systems Integration
    • BeSample Integration
    • Panelabs Integration
    • Clickworker Integration
    • Labvanced Webhook API
    • Labvanced REST API
    • About Us
    • Newsletter Archive
    • Terms & Conditions
    • Data Security & Data Privacy
    • Technical & Organisational Measures
    • Accessibility
    • W-8BEN-E Form
    • Data Processing Agreement Template
    LinkedInYouTubeDiscord
    • Individual
    • Lab
    • Department / Consortium
    • Teaching
    • Campus
    • Commercial
    • Browse recording top-ups →
    • Browse AI token top-ups →
    • Overview
    • Study Building
    • Subject Recruitment
    • Dedicated Support
    Checkout
  • Contact
    • EN
      • 中國人
      • Deutsch
      • Français
      • Español
      • English
      • 日本語
    • Logout
    • Loginlogin icon
    Platform
    Labvanced makes it easy to implement the most advanced study design and reliably collect your data.
    Biosignals & AI
    Remote Physiological MeasurementsEye TrackingHead & Face-TrackingEmotion DetectionHeart Rate Detection (rPPG)Generative AIAudio TranscriptionEEG & Hardware Integrations
    Behavioral Recordings
    Decision MakingReaction TimesKeyboard InputsMouse TrackingMobile / TouchQuestionnairesGamepad / Joystick Integration
    Media Recordings
    Audio RecordingsAudio TranscriptionVideo RecordingsScreen RecordingsPhotos / SnapshotsVideo ConferencingCanvas Drawings
    Implementation Techniques
    Build with AIBuild with SpreadsheetsUsing the Experiment EditorCodingCreating QuestionnairesBalancing & RandomizationUX & Website Testing
    Study Formats

    Your study can take whatever format your research needs. Here are a few popular examples.

    Single Session StudiesFactorial DesignsLongitudinal & Multi-session StudiesIndividual & Case StudiesReal-time Multi-user StudiesInterviews & Video CallsSurveys & QuestionnairesExperience Sampling & DiariesClassroom & Group TestingInterventions & Clinical Trials
    Where Studies Run

    Run your study online in the browser, on mobile or tablet with the mobile app, or in-lab with the desktop app.

    In the BrowserMobile AppDesktop AppWebBridge Chrome Extension
    Tests
    Explore cognitive tests, questionnaires, walkthroughs, and our public experiment library: a starting point for your next study.
    Popular Cognitive Tests
    Stroop TestFlanker TaskN-back TaskImplicit Association TestTrail Making TestDigit SpanCorsi Block TappingTower of LondonBalloon Analog Risk TaskPreferential Looking
    Browse more →
    Questionnaires & Scales
    DASS-21GAD-7Rosenberg Self-Esteem ScalePHQ-9Ten-Item Personality InventoryBig Five Personality TestAdult ADHD Self-Report Scale
    Browse more →
    Public Experiment Library

    Take a look at what other researchers in the community are doing through our extensive, open catalog of shared studies.

    Open the public library →
    Walkthroughs

    Step-by-step builds of complete studies, from a blank project to a running experiment, that you can follow along or adapt.

    Building a Multi-user StudyWebcam Eye Tracking with AOIsWebsite Frame Eye TrackingConditional Eye Tracking Opt-inChatGPT StudyDesktop App Study with EEGBetween-subjects Group BalancingBuilding a Reading StudyStroop TaskLexical Decision Task
    Browse more →
    Research
    One platform for students, academics, and industry researchers studying human behavior.
    Harvard UniversityStanford UniversityCambridge UniversityUCLNYUMax Planck InstituteUCLATU Munich

    Trusted by researchers at 1,500+ universities worldwide

    Academic Research
    Arts ResearchClinical Psychology & Neuropsychology MedicineCognitive PsychologyDevelopmental PsychologyBehavioral Economics & Decision ScienceEducational Research & PsychologyHCI & Human FactorsLinguistics & Language SciencesConsumer & Marketing ResearchSocial & Personality PsychologySport & Movement ScienceUX & Website Testing
    Research Areas
    Executive FunctionsLanguage & ReadingDecision-Making & ReasoningAttention
    Industry / Commercial
    OverviewHCI & Human FactorsUX & Website TestingConsumer & Marketing ResearchWhite-Label AppPageGazer
    Researcher Interviews

    Conversations with researchers about the studies they ran with Labvanced, what worked, and what they learned.

    Webcam vs. Lab Eye Tracking in InfantsAnna Banki & Gabriela MarkovaEye Tracking for Influencer MarketingDr. Alexander EdelingEye Tracking Infant Word ComprehensionDr. Giulia CalignanoSentence Reading and Grammar JudgmentsDr. Jonathan MiraultRegulating Emotions with MusicDr. Katrin StarckeGame-Based Grammar Learning in ChildrenDr. Mireia MarimonGaze Cueing and AutismMax Soares MiehsteinPersonality and Hearing in NoiseDr. Malte Wöstmann
    All interviews →
    Our Research
    Lab NotesHow to Cite Labvanced
    Peer Reviewed Studies

    A selection of peer-reviewed work built on Labvanced: our own platform and validation papers, and studies by the research community grouped by area. Hundreds more are listed on the full publications page.

    Labvanced Platform Paper (2017)Webcam Eye Tracking Validation (2024)Webcam Eye Tracking StudiesCognitive Psychology StudiesDevelopmental Psychology StudiesLinguistics Studies
    See all publications →
    Resources
    Valuable resources to help you learn the platform, stay updated, and more.
    Documentation
    Getting StartedGuideVideo TutorialsWalkthroughs
    Support
    Live ChatWebinars & Onboarding CallsAI AssistantFAQ
    Templates & Demos

    These are a few popular examples. Browse our guide and a selection of technical demos to get started with implementation.

    Importing Templates GuideTest TemplatesLive Eye Tracking MetricsMouse Tracking DemoChatGPT DemoAudio Recording Object DemoAdding Image Stimuli DemoScore & Feedback Demo
    Browse all technical demos →
    Methodology
    Timing PrecisionStimuli PresentationHeadphone ChecksBot ChecksParticipant ManagementComparisonsResearch Blog
    Integrations & APIs
    Prolific IntegrationCloudResearch IntegrationSona Systems IntegrationBeSample IntegrationPanelabs IntegrationClickworker IntegrationLabvanced Webhook APILabvanced REST API
    Company & Legal
    About UsNewsletter ArchiveTerms & ConditionsData Security & Data PrivacyTechnical & Organisational MeasuresAccessibilityW-8BEN-E FormData Processing Agreement Template
    LinkedInYouTubeDiscord
    Pricing
    Our licenses and additional services at a glance.
    Licenses
    IndividualLabDepartment / ConsortiumTeachingCampusCommercial
    Top-Ups

    Need more recordings for your lab or your own research? Simply use one of these recording top-up packages.

    Browse recording top-ups →

    Need more AI tokens for the AI assistant and study translations? Simply use one of these AI token top-up packages.

    Browse AI token top-ups →
    Additional Services

    Hire Labvanced’s expert team to quickly bring your project to the level of rigor it needs.

    OverviewStudy BuildingSubject RecruitmentDedicated Support
    Checkout

    Ready to purchase a license or top-up? Head straight to checkout.

    Go to checkout →
    • 中國人
    • Deutsch
    • Français
    • Español
    • English
    • 日本語
    • Getting Started
    • Guide
      • GETTING STARTED

        • Task Editor
        • Frames
          • Canvas Frame
          • Page Frame
          • Website Frame
          • Overlays & Dialogs | Labvanced
        • Trial Timeline
        • Stimulus Presentation
        • Correctness of Response
        • Objects
        • Events
        • Variables
        • Task Wizard
        • AI Assistant
        • Trial System
        • Experiment Design
          • Creating a Study
          • Importing Templates in Labvanced
          • Data Frame Patterns
          • Multi-user Experiment Design
          • Longitudinal Experiment Design
      • FEATURED TOPICS

        • Randomization & Balance
        • Eye Tracking
          • Presenting Stimuli in an Eye Tracking Task
          • How to Choose Eye Tracking Calibration Settings
          • Setting Up Eye Tracking in a Task
          • Recording and Exporting Gaze Data
          • Using Shapes as Areas of Interest (AOI) for Eye Tracking
          • The Participant Calibration Experience
        • Web Bridge
          • Selecting Website AOIs | Anchor, Adjust, and Verify AOI Tracking
          • Tracking Mouse Behavior on a Website AOI | Web Bridge Guide
        • Questionnaires
        • Desktop App
        • Sample Studies
        • Participant Recruitment
        • API Access
          • REST API
          • Webhook API
          • WebSocket API
        • Other Topics

          • Precise Stimulus Timings
          • Multi User Studies
          • Head Tracking in Labvanced | Guide
      • MAIN APP TABS

        • Overview: Main Tabs
        • Dashboard
        • My Studies
        • Shared Studies
        • My Files
        • Experiment Library
        • My Account
        • License & Services
      • STUDY TABS

        • Overview: Study-Specific Tabs
        • Study Design
          • Tasks
          • Blocks
          • Sessions
          • Groups
        • Task Editor
          • Task Controls
          • The Trial System
          • Frame Types
          • Objects
          • Object Property Tables
          • Variables
          • System Variables Table
          • The Event System
          • Text Editor Functions
          • Eye Tracking Options in the Task Editor
          • Head Tracking in a Task
          • Multi-User Studies
        • Settings
        • Variables
        • Media
        • Texts & Translate
        • Launch & Participate
        • Subject Management
        • Dataview and Export
    • Video Tutorials
      • Video Overview
      • Getting Started in Labvanced
      • Creating Tasks
      • Element Videos
      • Events & Variables
      • Advanced Topics
    • Walkthroughs
      • Introduction
      • Stroop Task
      • Lexical Decision Task
      • Posner Gaze Cueing Task
      • Change Blindness Flicker Paradigm
      • Eye-tracking Sample Study
      • Infant Eye-tracking Study
      • Attentional Capture Study with Mouse Tracking
      • Rapid Serial Visual Presentation
      • ChatGPT Study
      • Eye Tracking Demo: SVGs as AOIs
      • Multi-User Demo: Show Subjects' Cursors
      • Gamepad / Joystick Controller- Basic Set Up
      • Desktop App Study with EEG Integration
      • Between-subjects Group Balancing and Variable Setup
      • Building a Multi-user Study
      • Website Frame Eye Tracking Walkthrough
      • Conditional Webcam Eye Tracking
      • Text Segmentation Study Building
      • Building a Study with AI
    • FAQ
      • Features
      • Support Policy & Guidelines
      • Security & Data Privacy
      • Licensing
      • Precision of Labvanced
      • Programmatic Use & API
      • Using Labvanced Offline
      • Troubleshooting
      • Study Creation Questions

    REST API

    Labvanced offers a REST API for users to fetch data from the Labvanced server, after the participant(s) completed the study.

    The REST API is authenticated with a token, that allows you to download all of your data programmatically. The REST API is great for organizations and academic research institutions who want to centralize their data fetching and store their data in dedicated places as per their pipeline protocol. Instead of selecting and downloading data manually and saving it locally, this allows organizations to access the data on their servers which is also important for GDPR protocol.

    The documentation (Swagger UI) of the rest endpoints can be found here: https://www.labvanced.com/openapi.html

    We also provide an openapi specification that can be used to autogenerate client code for different programming languages (i.e. in tools like Postman): https://www.labvanced.com/labvanced-openapi.json

    Creating the API Token

    This is a secured API, meaning you need to validate access using a token generated in Labvanced in order to access the data.

    To create the token, log into the Labvanced app and go to the ‘My Account’ tab located on the left side of the menu.

    There is a section called ‘API Credentials’ and to create the token, simply click ‘Generate.’

    indicating the button that generates the REST API

    When the token appears, double click the token key in order to highlight it all and then Ctrl+C to copy it.

    With this token, you will be able to access the data from your studies and the relevant sessions.

    Note: the token can only be generated to give access to the session data by the study owner.

    Try it out using our API Documentation (Swagger UI)

    The simplest way to try out our API is to use the "Try it out" functionality in our API documentation (Swagger UI): https://www.labvanced.com/openapi.html

    In the upper right corner, you click ‘Authorize’.

    indicating the 'Authorize' button for inputting the REST API

    This will open a dialogue box which prompts you to enter / paste the token in the ‘Value’ field.

    Dialog box for inputting the REST API credentials

    Once you paste the token, click ‘Authorize’ then ‘Close’ to close the dialog box.

    Note: When you are finished looking at the data, you can log out of this session by clicking ‘Authorize’ found at the top right corner of the website and then, in the dialog box that appears, by clicking the ‘Logout’ button that appears in the bottom left corner.

    Try out Accessing Data via our API Documentation

    Once you are logged in, you can make use of these two areas in order to access your experimental data:

    Data options from the REST API for accessing sessions and participant data

    • /api/{expId}/download/{recSessionId}: this section allows you to access and download a single participant’s data. When the data is downloaded it will be in a .csv file format as per the configuration you have specified in the exportSettings found on the ‘Dataview & Export’ page in the Labvanced app.
    • /api/{expId}/sessions: allows you to retrieve all the sessions for a specific experiment by inputting the ‘experiment id.’

    Data from ‘/api/{expId}/sessions’

    It is best to start with the second endpoint to first find out what recording sessions (and their corresponding rec_session_id) exist in a given experiment. You click the second blue field labeled /api/{expId}/sessions and it will open into a larger view and click the ‘Try it out’ button on the right side:

    Dialog box for fetching experiment data with the REST API based on the session id

    By clicking ‘Try it out’ you will be able to input numbers into the ‘expid’ field to indicate the experiment id you want to access the session data for. You can find this in labvanced in the "My Studies" page in column "ID". Once you fill in this field, you click ‘Execute.’

    Once you do this, you can scroll down and see the information for all the sessions in that specific experiment:

    Example of session data generated using the REST API

    Please note down one of the rec_session_id from the response payload to use it in the next section to download all the recorded data of that recording session.

    Note: To input a different ‘experiment id’, simply click the red ‘Cancel’ button on the right side, in order to be able to input a new ‘experiment id.’

    Data from ‘recSessionId’

    To access and download a participant’s data, you click the first blue field labeled /api/{expId}/download/{recSessionId} and it will open into a larger view and click the ‘Try it out’ button on the right side:

    Dialog for specifying the experiment id and session numbers for fetching data via the REST API

    By clicking ‘Try it out’ you will be able to input numbers into the two fields that appear by indicating the ‘experiment id’ and ‘rec_session_id’ that you want to download (see previous section).

    Once you input these values, simply click ‘Execute’ and the API will run. Then you scroll down, and you will see an option to ‘Download file.’

    Downloading files generated by the REST API

    Upon clicking ‘Download file’ a .zip will be downloaded containing two .csv files, namely the:

    • sessions.csv
    • trials.csv

    These files will contain all the relevant data for the specific session and the associated trial data.

    Note: To fetch a different session, simply click the red ‘Cancel’ button on the right side, in order to be able to input a new ‘experiment id’ and a new ‘rec_session_id’ to download.

    In conclusion, these steps allow you to access data using the API token you have generated using a unique and secured token in Labvanced in order to view experimental and session data.

    Try it out using Postman

    This is a second option to try out the API for those who are using Postman (an API platform) already in their day-to-day activities. The Labvanced API token also works from there.

    You enter the URL at the top field, based on the Labvanced API website.

    Then, select the Key and paste the token under the ‘value’ column, as shown below:

    Demonstration of how to use POSTMAN with the Labvanced-generated REST API

    This way, the session data for an experiment will be accessible through Postman.

    Similarly, you can follow the same process in order to download files for a specific participant.

    When doing this, the preview will show odd characters but this is normal because this command is for fetching files. When you click ‘Save Responses’ and ‘Save to a file’ the data for the particular participant will appear normally.

    Demonstration of how file-based data appears in POSTMAN with the Labvanced REST API

    Next
    Webhook API