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
    • ZH
      • 中國人
      • 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
    • 日本語
    • 入门
    • 指南
      • 入门

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

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

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

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

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

    Webhook API

    使用方法: ​Labvanced外部数据存储Webhook API的主要用例是将参与者数据“实时”传输到外部/远程服务器,而不是将记录的数据托管在Labvanced服务器上。

    请注意: ​与许多API用例相反,这里描述的内容并不是如何调用Labvanced API/端点(目前不存在这种功能),而是您必须如何配置/实现您的后端,以使我们的平台能够自动调用您实现的端点,将参与者数据直接发送到您的后端/数据库,而不是我们的。

    可用性: ​此功能仅对Labvanced实验室许可证持有者可用。

    1. 设置Webhook API

    要使用Webhook API,您首先必须在“实验功能”部分的相应Labvanced研究的“研究设置”中激活“外部数据存储”选项。

    1.1 参数:

    • IP地址: 输入您的静态IP地址,外部服务器正在运行/可公开访问。
    • 端口: 应用来发送数据的端口
    • URL路径: 应该在端口后附加的URL路径。这对于对您的项目/传入数据进行“命名空间”特别有用,以便来自不同实验的数据发送到不同的URL路径。URL路径是可选的,但我们强烈建议使用它。

    2. 创建接收Webhook API数据的服务器/脚本

    根据第1步中的设置,您必须实现一个在指定的IP地址、端口和URL路径上可用的服务器。这样的服务器的简化版本/示例可以在我们的Github页面找到。

    2.1 数据格式: 数据以JSON格式发送,除了“/file_upload”路由之外。 “/file_upload”路由(用于上传二进制文件,例如录制的视频或音频)编码为“multipart/form-data”,因此请确保您正确解析传入数据为JSON或multipart/form-data /二进制数据。

    2.2 CORS设置: 在实现您的后端时,您必须实现/允许跨域资源共享(CORS)。尤其是,您必须设置以下标头:“Access-Control-Allow-Origin”(包括 ​https://www.labvanced.com/​), “Access-Control-Allow-Methods”(包括POST和OPTIONS), “Access-Control-Allow-Headers”(包括Content-Type)

    2.3 请求类型: ​所有请求类型都是POST请求,因为它们用于发送数据。在此时,仅“/file_upload”路由需要返回值。所有其他路由不需要特殊的返回值。

    2.4 请求/路由类型: ​每当参与者参加研究时,方将发送总共8种不同类型的POST请求到(外部/您的)服务器。仅在您的研究中包含上传录制的二进制数据(例如音频或视频)的操作时,才会使用“/file_upload”路由。每种类型的POST请求都有不同的路由(URL路径),将在第1步中附加到指定的URL路径。此外,每种类型的请求都有不同的结构/有效负载,这在解析和存储数据时应考虑。详见第3节。

    3. Webhook API端点定义/路由:

    在下面,您将看到参与者参加实验时使用/调用的每个路由/端点的详细说明。理想情况下,我们建议您实现所有这些端点(除了3.1),确保所有数据都被适当地解析和存储在您的数据库中。

    哪些端点被使用,何时调用哪个服务器?

    • 端点3.1 “/startExpPlayer”仅发送到Labvanced服务器,以加载实验定义/ JSON文件和相关刺激。
    • 端点3.2、3.3、3.4、3.7和3.8同时发送到Labvanced服务器(用于组平衡和一般实验流所需)和外部/您的服务器。
    • 端点3.5和3.6仅发送到外部/您的服务器。请注意,所有试验/参与者数据通过路由3.6发送,因此这是最重要的端点需要实现。
    • 端点3.9仅发送到外部/您的服务器,并在每次执行“上传操作”以上传二进制(音频或视频)数据时调用。

    3.1 加载实验

    • 路由: /startExpPlayer
    • 类型: POST
    • 调用时: 当参与者访问 labvanced.com 上的某个实验URL时。Lavanced服务器上的主要功能:初始化实验的加载。
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expId研究的唯一标识符整数是
    isTestrun数据是否被记录布尔否
    subject_code通过URL参数识别的主题字符串否
    token一种用于纵向研究中参与者的唯一标识符Token identifier否
    askSubjData是否显示初始调查,用于将主题分入不同组布尔是

    注意: 不需要在外部服务器上实现,因为这只初始化从Labvanced服务器到客户端计算机的实验加载


    3.2 组和会话选择

    • 路由: /startFirstPlayerSession
    • 类型: POST
    • 调用时: 路由3.1“/startExpPlayer”从Labvanced服务器成功返回时。
    • Lavanced服务器上的主要功能: 用于将组和会话编号分配给参与者(服务器侧平衡)。
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expId研究的唯一标识符整数是
    expSessionNr该参与者录制会话的唯一标识符(向上计数)字符串是
    subject_code通过URL参数识别的主题字符串否
    token一种用于纵向研究中参与者的唯一标识符Token identifier否
    survey_data前研究问卷的JSON,字段在下面描述。JSON否
    survey_data.selectedGender参与者选择的性别字符串否
    survey_data.selectedAge参与者选择的年龄整数否
    survey_data.selectedCountry参与者选择的国家/位置字符串否
    survey_data.selectedLanguage参与者选择的(第一)语言字符串否
    isTestrun数据是否被记录布尔是
    runOnlyGroupNr仅用于测试运行某个特定组编号而不进行数据记录整数 / 假否
    runOnlySessionNr仅用于测试运行某个特定会话编号而不进行数据记录整数 / 假否
    groupNr对于该主题的组编号整数是
    sessionNr纵向研究中的会话编号整数是
    group_name对于该主题的组的名称字符串是
    session_name对于该主题的会话的名称字符串是
    experiment_name实验名称(不是出版名称)字符串是

    3.3 实验开始

    • 路由: /setPlayerSessionStartedTime
    • 类型: POST
    • 调用时: 当参与者按下“开始实验”时
    • Lavanced服务器上的功能: 保存实验的开始时间、会话和组名,并开始实验。
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expId研究的唯一标识符整数是
    expSessionNr该参与者录制会话的唯一标识符(向上计数)字符串是
    start_time实验的开始时间UNIX时间戳是
    sessionNr纵向研究中的会话编号整数是
    groupNr对于该主题的组编号整数是
    token一种用于纵向研究中参与者的唯一标识符Token identifier否

    3.4 添加元数据

    • 路由: /addMetaInfo
    • 类型: POST
    • 调用时: 当参与者按下“开始实验”时
    • Lavanced服务器上的功能: 在服务器上保存元信息。
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expId研究的唯一标识符整数是
    expSessionNr该参与者录制会话的唯一标识符(向上计数)字符串是
    var_data包含元信息的JSONJSON是
    var_data.browserSpec参与者使用的浏览器字符串否
    var_data.versionSpec参与者使用的浏览器版本字符串否
    var_data.systemSpec参与者使用的设备类型/操作系统字符串否
    var_data.agentSpec完整的用户代理字符串字符串否
    var_data.fullscreen表示研究是否始终全屏布尔否
    var_data.timeDelayMeanJavaScript回调精度均值偏移(毫秒)浮点否
    var_data.timeDelayStdJavaScript回调精度标准偏差(毫秒)浮点否
    var_data.crowdsourcingCode参与者的众包/完成代码字符串否
    var_data.crowdsourcinSubjId参与者的众包/工人ID字符串否
    var_data.subjCounterGlobal研究中参与者的全局计数器整数否
    var_data.subjCounterPer Group研究中每组的参与者计数器整数数组否
    var_data.roleId多用户研究的参与者唯一角色ID整数否
    var_data.multiUserGroupId多用户研究的全局唯一多用户组IDUuid否
    var_data.displayedLanguage多语言研究中选择的显示语言字符串否
    var_data.pixelDensityPerMM屏幕的像素密度浮点否
    var_data.screenHeight屏幕的高度(像素)整数否
    var_data.screenWidth屏幕的宽度(像素)整数否
    var_data.windowHeight窗口/视口高度(像素)整数否
    var_data.windowWidth窗口/视口宽度(像素)整数否

    3.5 记录任务信息

    • 路由: /recordStartTask
    • 类型: POST
    • 调用时: 实验流程中开始一个新任务时
    • Lavanced服务器上的功能: 当启用外部API请求时不被调用
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expId研究的唯一标识符整数是
    expSessionNr该参与者录制会话的唯一标识符(向上计数)字符串是
    blockNr当前块编号(递增计数器)整数是
    blockId当前块的唯一IDUuid是
    blockName块的名称字符串是
    taskNr当前任务编号(递增计数器)整数是
    taskId当前任务在编辑器中定义的ID(在参与者之间相同)Uuid是
    recTaskId当前录音任务的服务器生成ID(在参与者之间不同)整数是
    taskName当前任务的名称字符串是
    start_time任务的开始时间UNIX时间戳是

    3.6 记录试次数据

    • 路由: /recordTrial
    • 类型: POST
    • 调用时: 试次完成或执行自定义记录操作时
    • Lavanced服务器上的功能: 当启用外部API请求时不被调用。
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expId研究的唯一标识符整数是
    expSessionNr该参与者录制会话的唯一标识符(向上计数)字符串是
    recTaskId当前录音任务的服务器生成ID(在参与者之间不同)整数是
    taskId当前任务在编辑器中定义的ID(在参与者之间相同)Uuid是
    trailNr试次编号整数是
    recData其他主要数据/每个试次创建的所有用户变量存储在此JSON是

    注意: 每个试次记录的数据的确切内容取决于具体实验和任务。每项研究的概述可以在具体实验的“变量”选项卡下找到(见截图)。还请注意,外部API变量名称将在JSON结构中用作键。因此,请确保变量名称是唯一的。否则您将覆盖数据。Labvanced系统通常要求用户使用唯一的变量名称。

    Labvanced中变量选项卡的概述

    3.7 成功完成实验

    • 路由: /finishExpSession
    • 类型: POST
    • 调用时: 实验成功完成时
    • Lavanced服务器上的功能: 完成研究并将数据集标记为已完成(对平衡很重要)。
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expId研究的唯一标识符整数是
    expSessionNr该参与者录制会话的唯一标识符(向上计数)字符串是
    end_time实验结束的时间UNIX时间戳是
    var_data与“/​addMetaInfo​”路由中的var数据相同(已更新信息)JSON是
    nextStartTime下一个开始时间(仅适用于纵向研究)UNIX时间戳否
    nextEndTime下一个结束时间(仅适用于纵向研究)UNIX时间戳否
    reminderTime下一个开始时间之前的时间(仅适用于纵向研究)时间字符串否
    selectedEmail发送参与提醒的邮件(仅适用于纵向研究)电子邮件地址否
    emailReminder何时发送提醒(仅适用于纵向研究)字符串否

    3.8 实验失败

    • 路由: /errExpSession
    • 类型: POST
    • 调用时: 实验以错误终止
    • Lavanced服务器上的功能: 中止研究并将数据集标记为不完整
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expId研究的唯一标识符整数是
    expSessionNr该参与者录制会话的唯一标识符(向上计数)字符串是
    err_msg错误消息字符串是

    3.9 上传二进制(音频或视频)数据

    • 路由: /file_upload
    • 类型: POST
    • 调用时: 在与某些音频或视频录制对象相关联的事件系统中执行上传操作时。 Lavanced服务器上的功能:当启用外部API请求时不被调用。
    • 注意: 服务器必须为此路由发送返回值(如下所述)。如果不这样做,“onUploadComplete”触发器将不会执行,实验将无法正确传播。还要注意,此路由中的数据编码为“multipart/form-data”,因为它同时包含二进制和非二进制数据。
    • 有效负载: JSON,包含以下字段:
    字段名称描述数据类型必需
    expSessionNr该参与者录制会话的唯一标识符(向上计数)字符串是
    newFileName建议的文件名,用于存储文件。文件名包括相关变量名称,以及当前块、任务和试次编号。字符串是
    myFile实际文件/二进制数据二进制是

    所需响应:

    字段名称描述数据类型必需
    file_guid记录文件的全局唯一标识符(guid)。必须在服务器端生成,并将保存与文件相关联的变量,以便后来容易理解哪个文件来自哪个录制对象。Uuid是
    file_name服务器用于保存文件的结果文件名。它可以(但不一定)与客户端在请求中建议的文件名相同。这也将存储在关联变量中。字符串是
    Prev
    REST API
    Next
    WebSocket API