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
    Top-Ups
    • Overview
    • Study Building
    • Subject Recruitment
    • Dedicated Support
    Checkout
  • Contact
    • ZH
      • 中國人
      • Deutsch
      • Français
      • Español
      • English
      • 日本語
    • Appgo to app icon
    • 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 top-up packages →
    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
    • 日本語
    • 入门
    • 指南
      • 入门

        • 任务编辑器
        • 框架
          • 画布框架
          • 页面框架
          • 网站框架
        • 试验时间线
        • 刺激呈现
        • 反应的正确性
        • 对象
        • 事件
        • 变量
        • 任务向导
        • AI助手
        • 试验系统
        • 实验设计
          • 创建研究
          • 在 Labvanced 中导入模板
          • 数据框模式
          • 多用户实验设计
          • 纵向实验设计
      • 特色主题

        • 随机化与平衡
        • 眼动追踪
          • 在眼动追踪任务中呈现刺激
          • 如何选择眼动追踪校准设置
          • 在任务中设置眼动追踪
          • 记录和导出注视数据
          • 使用形状作为兴趣区域 (AOI) 进行眼动跟踪
          • 参与者校准体验
        • 网络桥接
          • 选择网站 AOI | 锚点、调整和验证 AOI 跟踪
          • 在网站区域(AOI)上跟踪鼠标行为 | Web Bridge指南
        • 问卷
        • 桌面应用
        • 示例研究
        • 参与者招募
        • API访问
          • REST API
          • Webhook API
          • WebSocket API
        • 其他主题

          • 精确刺激时序
          • 多用户研究
          • 头部追踪在 Labvanced 中 | 指南
      • 主应用标签

        • 概述:主标签
        • 仪表板
        • 我的研究
        • 共享研究
        • 我的文件
        • 实验库
        • 我的账户
        • 许可与服务
      • 研究标签

        • 概述:研究特定标签
        • 研究设计
          • 任务
          • 区块
          • 会话
          • 组
        • 任务编辑器
          • 任务控制
          • 试验系统
          • 框架类型
          • 对象
          • 对象属性表
          • 变量
          • 系统变量表
          • 事件系统
          • 文本编辑器功能
          • 任务编辑器中的眼动追踪选项
          • 任务中的头部追踪
          • 多用户研究
        • 设置
        • 变量
        • 媒体
        • 文本与翻译
        • 启动与参与
        • 受试者管理
        • 数据视图与导出
    • 视频教程
      • 视频概述
      • 在Labvanced中入门
      • 创建任务
      • 元素视频
      • 事件与变量
      • 高级主题
    • 演练
      • 介绍
      • 斯特鲁普任务
      • 词汇决策任务
      • 波斯纳注视提示任务
      • 变化盲点闪烁范例
      • 眼动追踪示例研究
      • 婴儿眼动追踪研究
      • 基于鼠标跟踪的注意力捕获研究
      • 快速串行视觉呈现
      • ChatGPT研究
      • 眼动追踪演示:SVG作为AOI
      • 多用户演示:显示受试者光标
      • 游戏手柄/摇杆控制器-基础设置
      • 集成EEG的桌面应用程序研究
      • 被试间组平衡和变量设置
      • 构建多用户研究
      • 网站框架眼动追踪演练
      • 条件性网络摄像头眼动追踪
      • 文本分割研究构建
      • 构建AI研究
    • 常见问题
      • 功能
      • 支持政策和指南
      • 安全与数据隐私
      • 许可
      • Labvanced的精确度
      • 编程使用与API
      • 离线使用Labvanced
      • 故障排除
      • 研究创建问题

    REST API

    Labvanced 提供 REST API,供用户在参与者完成研究后从 Labvanced 服务器中获取数据。

    该 REST API 通过令牌进行身份验证,允许您以编程方式下载所有数据。REST API 非常适合希望集中数据获取并根据其流程协议将数据存储在专用位置的组织和学术研究机构。它允许组织访问其服务器上的数据,这对于 GDPR 协议也很重要,而不是手动选择和下载数据并将其保存在本地。

    REST 端点的文档 (Swagger UI) 可以在此找到: https://www.labvanced.com/openapi.html

    我们还提供一个可以用来为不同编程语言(即在 Postman 等工具中)自动生成客户端代码的 OpenAPI 规范: https://www.labvanced.com/labvanced-openapi.json

    创建 API 令牌

    这是一个安全的 API,这意味着您需要使用在 Labvanced 中生成的令牌来验证访问数据。

    要创建令牌,请登录 Labvanced 应用程序,然后转到菜单左侧的“我的帐户”选项卡。

    有一个名为“API 凭据”的部分,只需点击“生成”即可创建令牌。

    indicating the button that generates the REST API

    当令牌出现时,双击令牌密钥以突出显示,并按 Ctrl+C 复制它。

    有了这个令牌,您将能够访问您的研究和相关会话的数据。

    注意: 令牌只能由研究所有者生成,以提供对会话数据的访问。

    使用我们的 API 文档 (Swagger UI) 进行尝试

    尝试使用我们 API 的最简单方法是使用 API 文档 (Swagger UI) 中的“尝试它”功能: https://www.labvanced.com/openapi.html

    在右上角,您点击“授权”。

    indicating the 'Authorize' button for inputting the REST API

    这将打开一个对话框,提示您在“值”字段中输入/粘贴令牌。

    Dialog box for inputting the REST API credentials

    粘贴令牌后,点击“授权”,然后点击“关闭”以关闭对话框。

    注意: 当您看完数据后,可以通过点击网站右上角的“授权”注销该会话,然后在弹出的对话框中点击左下角的“注销”按钮。

    尝试通过我们的 API 文档访问数据

    一旦您登录,您可以利用这两个区域来访问您的实验数据:

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

    • /api/{expId}/download/{recSessionId}: 该部分允许您访问和下载单个参与者的数据。当数据下载时,它将以您在 Labvanced 应用程序的 ‘数据视图与导出’ 页面中指定的 exportSettings 配置的 .csv 文件格式下载。
    • /api/{expId}/sessions: 通过输入“实验 ID”,允许您检索特定实验的所有会话。

    来自 ‘/api/{expId}/sessions’ 的数据

    最好先从第二个端点开始,首先找出某个实验中存在的记录会话(及其对应的 rec_session_id)。 您点击第二个蓝色字段 /api/{expId}/sessions,它会打开一个更大的视图,然后点击右侧的“尝试它”按钮:

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

    通过点击“尝试它”,您将能够在“expid”字段中输入数字,以指示要访问的会话数据的实验 ID。您可以在 Labvanced 的“我的研究”页面的“ID”列中找到此 ID。填好该字段后,点击“执行”。

    执行后,您可以向下滚动并查看该特定实验中所有会话的信息:

    Example of session data generated using the REST API

    请记下响应负载中的 rec_session_id 之一,以便在下一节中使用它来下载该记录会话的所有记录数据。

    注意: 要输入不同的“实验 ID”,只需单击右侧的红色“取消”按钮,以便能够输入新的“实验 ID”。

    来自 ‘recSessionId’ 的数据

    要访问和下载参与者的数据,您点击第一个蓝色字段 /api/{expId}/download/{recSessionId},它会打开一个更大的视图,然后点击右侧的“尝试它”按钮:

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

    通过点击“尝试它”,您将能够在出现的两个字段中输入数字,以指示您想要下载的“实验 ID”和“rec_session_id”(见上一节)。

    输入这些值后,只需点击“执行”,API 将运行。接着向下滚动,您将看到“下载文件”的选项。

    Downloading files generated by the REST API

    点击“下载文件”后,将下载一个 .zip 文件,其中包含两个 .csv 文件,分别为:

    • sessions.csv
    • trials.csv

    这些文件将包含特定会话和相关试验数据的所有相关数据。

    注意: 要获取不同的会话,只需单击右侧的红色“取消”按钮,以便能够输入新的“实验 ID”和新的“rec_session_id”进行下载。

    总之,这些步骤允许您使用在 Labvanced 中生成的唯一且安全的令牌访问数据,以查看实验和会话数据。

    使用 Postman 进行尝试

    这是那些已经在日常活动中使用 Postman(一个 API 平台)的用户尝试 API 的第二个选项。 Labvanced API 令牌在此也有效。

    您在顶部字段中输入 URL,基于 Labvanced API 网站。

    然后,选择密钥并将令牌粘贴到“值”列中,如下所示:

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

    这样,实验的会话数据将可以通过 Postman 访问。

    同样,您可以按照相同的流程下载特定参与者的文件。

    在这样做时,预览将显示奇怪的字符,但这很正常,因为此命令用于获取文件。当您点击“保存响应”和“保存到文件”时,该特定参与者的数据将正常出现。

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

    Next
    Webhook API