Skip to main content
Version: v1.0.0


The ParticipantMetadata object contains metadata about the participant. This includes the user agent, resolution, language, and IP address. This object is used to store information about the participant that is not directly related to the study itself.


ipnull | stringThe IP address of the participant.
languagestringThe language of the participants browser.
resolutionRecord<string, string | number>The resolution of the participants screen. This is an object with two keys, "width" and "height". The values are the width and height of the participants screen in pixels.
userAgentstringThe user agent of the participant. This is a string that contains information about the participants browser and operating system.