All event streams in the LAMP API are catalogued by a timestamp and specific "blueprints" (schema) of what kind of data they hold. For example, a sensor event that occurred 20 minutes ago would carry that instant's timestamp, along with a link to what kind of sensor it was, and that sensor's measurement as a payload of data. The kinds of activities and sensors available are declared below, along with the blueprint you can expect their events' data to follow.
To learn more about accessing these data types, follow along with either of these tutorials:
Activity Types
In the case of activities (active data) completed by the participant or patient, the activity declares two types of blueprints: static data, or data that relates to the overall session, and temporal slices, data that provides millisecond precision and carries information about each action or intention the participant or patient might have. Furthermore, activities that can be customized will also have settings blueprints, but these won't actually appear in the event data (and are omitted from the fields listed below).
Fields
CSV Field | View In App | Description | Slot Name 2 | Static Data Slot #1 | Slot Name 1 | Static Data Slot #2 | Slot Name | Static Data Slot #3 | Slot Name 3 | Static Data Slot #4 | Slot Name 4 | Static Data Slot #5 | TemporalSlice.Item | TemporalSlice.Value | TemporalSlice.Type | TemporalSlice.Duration | TemporalSlice.Level |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lamp.survey | Customizable surveys. | The question index. | The selected question option index. | The click range ("valid" or "none") for the question. | The time taken to answer a question in the survey. | ||||||||||||
lamp.nback | The NBack test. | score | The computed score for the completed session. | correct_answers | The total number of correct answers made in the session. | wrong_answers | The total number of incorrect answers made in the session. | total_questions | The total number of questions encountered during the session. | version | The version of the test played. | ||||||
lamp.nback_new | The Trails B test. | point | The associated point value with the completed session. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | total_attempts | The total number of attempts made during the session. | Unused | The alphanumeric index of the item tapped. | Whether the correct index was tapped or not ("correct" or "none"). | The time between the recording of this detail and the previous one (or the start of the activity, if no previous detail exists). | The current sequence index in the game. | |||
lamp.spatial_span | The Spatial Span test, with Forward and Backward variants. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | correct_answers | The total number of correct answers made in the session. | wrong_answers | The total number of incorrect answers made in the session. | type | The integer indicating forward or backward variant. | The game index. | The current sequence index in the session. | Whether the correct item was tapped or not ("correct" or "none"). | The time between the recording of this detail and the previous one (or the start of the activity, if no previous detail exists). | The current level reached during the session. | |
lamp.simple_memory | The Simple Memory test. | score | The computed score for the completed session. | correct_answers | The total number of correct answers made in the session. | wrong_answers | The total number of incorrect answers made in the session. | total_questions | The total number of questions encountered during the session. | version | The version of the test played. | ||||||
lamp.serial_7s | The Serial 7s test. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | total_attempts | The total number of attempts made during the session. | total_questions | The total number of questions encountered during the session. | version | The version of the test played. | ||||||
lamp.cats_and_dogs | The Cats and Dogs game. | point | The associated point value with the completed session. | rating | The associated rating of the completed session. | correct_answers | The total number of correct answers made in the session. | wrong_answers | The total number of incorrect answers made in the session. | total_questions | The total number of questions encountered during the session. | ||||||
lamp.3d_figure_copy | The 3D Figure drawing game. | point | The associated point value with the completed session. | drawn_file_name | The link to the file containing the drawn image. | game_name | The unique game name for the drawing session. | ||||||||||
lamp.visual_association | The Visual Association test. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | total_attempts | The total number of attempts made during the session. | total_questions | The total number of questions encountered during the session. | version | The version of the test played. | ||||||
lamp.digit_span | The Digit Span test, with Forward and Backward variants. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | correct_answers | The total number of correct answers made in the session. | wrong_answers | The total number of incorrect answers made in the session. | type | The integer indicating forward or backward variant. | ||||||
lamp.cats_and_dogs_new | The new variant of the Cats and Dogs game. | point | The associated point value with the completed session. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | correct_answers | The total number of correct answers made in the session. | wrong_answers | The total number of incorrect answers made in the session. | ||||||
lamp.temporal_order | The Temporal Order test. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | correct_answers | The total number of correct answers made in the session. | wrong_answers | The total number of incorrect answers made in the session. | version | The version of the test played. | ||||||
lamp.nback_new | The new variant of the NBack test. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | correct_answers | The total number of correct answers made in the session. | wrong_answers | The total number of incorrect answers made in the session. | total_questions | The total number of questions encountered during the session. | ||||||
lamp.trails_b_new | The new variant of the Trails B test. | point | The associated point value with the completed session. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | total_attempts | The total number of attempts made during the session. | version | The version of the test played. | The alphanumeric index of the item tapped. | Whether the correct item was tapped or not ("correct" or "none"). | The time between the recording of this detail and the previous one (or the start of the activity, if no previous detail exists). | The current sequence index in the game. | ||
lamp.trails_b_dot_touch | The new dot-touch variant of the Trails B test. | point | The associated point value with the completed session. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | total_attempts | The total number of attempts made during the session. | The alphanumeric index of the item tapped. | Whether the correct item was tapped or not ("correct" or "none"). | The time between the recording of this detail and the previous one (or the start of the activity, if no previous detail exists). | The current sequence index in the game. | ||||
lamp.jewels_a | The Jewels game, variant A. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | total_attempts | The total number of attempts made during the session. | total_bonus_collected | The total bonus collected during the session. | total_jewels_collected | The total jewels collected during the session. | The alphanumeric jewel index tapped. | Whether the correct jewel was tapped or not ("correct" or "none"). | The time between the recording of this detail and the previous one (or the start of the activity, if no previous detail exists). | The current sequence index in the game. | ||
lamp.jewels_b | The Jewels game, variant B. | rating | The associated rating of the completed session. | score | The computed score for the completed session. | total_attempts | The total number of attempts made during the session. | total_bonus_collected | The total bonus collected during the session. | total_jewels_collected | The total jewels collected during the session. | The alphanumeric jewel index tapped. | Whether the correct jewel was tapped or not ("correct" or "none"). | The time between the recording of this detail and the previous one (or the start of the activity, if no previous detail exists). | The current sequence index in the game. |
Sensor Types
Active sensor events are produced on a rolling basis via interactions by a Participant. They are transferred to the Platform Server automatically by using the Activity API written in JavaScript. By “beginning” and “ending” a recording of these interactions, as well as “emitting” temporal data during the interaction, an ActivityEvent can be captured and sent to the Platform Server. A list of existing Sensors is provided below with name and description; a live server instance must be consulted for data schema information (see GET /sensor_spec). Implementations for these hardware sensors are provided in the GitHub repository.
lamp.accelerometer.motion: records processed triaxial motion, triaxial rotation, triaxial gravity, and triaxial magnetic field data.
- tilt
- roll: number
- pitch: number
- yaw: number
- rotation
- x: number
- y: number
- z: number
- gravity
- x: number
- y: number
- z: number
- user_accel
- x: number
- y: number
- z: number
- magnetic_field
- x: number
- y: number
- z: number
- calibration: number
lamp.analytics: records events such as page opens, notification receipt, or login sessions.
- This data type is currently for internal use only.
- event_name: string
- event_payload: any
lamp.blood_pressure: records blood pressure from an external connected monitor.
- value: number
- units: string
lamp.calls: records calls after encrypting the phone number.
- phone_number: string
- duration: number
- call_type: string<incoming, outgoing, missed, busy>
lamp.distance: records total distance moved.
- value: number
- units: string
lamp.bluetooth: records bluetooth devices within range as well as signal strength.
- device_id: string
- frequency: number
- rssi: number
lamp.flights: records stairs of flights climbed.
- value: number
- units: string
lamp.height: records self-reported height.
- value: number
- units: string
lamp.magnetometer: records triaxial magnetic field changes.
- x: number
- y: number
- z: number
lamp.respiratory_rate: records respiratory rate from an external connected monitor.
- value: number
- units: string
lamp.heart_rate: records heart rate from an external connected monitor.
- value: number
- units: string
lamp.segment: records workout segment duration and length.
- value: number
- units: string
lamp.gyroscope: records unprocessed triaxial gyroscope data.
- x: number
- y: number
- z: number
lamp.sms: records text messages after encrypting the phone number.
- phone_number: string
- length: integer
- sms_type: string<sent, received>
lamp.sleep: records sleep duration with start and stop times.
- value: number
- units: string
lamp.weight: records self-reported weight, or weight from an external connected monitor.
- value: number
- units: string
lamp.steps: records number of steps taken since last such event, or the start of the day.
- value: number
- units: string
lamp.wifi: records encrypted wireless hotspots as well as signal strength.
- device_id: string
- frequency: number
- rssi: number
Was there something we didn't cover, or need more help? Let us know by making a post in the LAMP Community, or contact us directly. Thank you for your contribution! 🌟 Page last updated on January 25th, 2021.