LAMP Platform User Guide
LAMP Platform User Guide
🔬

Data Types

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:

or
📈
Preparing to analyze your data in Python
.

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 FieldView In AppDescriptionSlot Name 2Static Data Slot #1Slot Name 1Static Data Slot #2Slot NameStatic Data Slot #3Slot Name 3Static Data Slot #4Slot Name 4Static Data Slot #5TemporalSlice.ItemTemporalSlice.ValueTemporalSlice.TypeTemporalSlice.DurationTemporalSlice.Level
lamp.survey
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
N-Back (Removed, Unavailable)
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
Trails B (Removed, Unavailable)
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
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
Simple Memory (Removed, Unavailable)
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
Serial 7s (Removed, Unavailable)
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
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
3D Figure Copy (Removed, Unavailable)
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
Visual Association (Removed, Unavailable)
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
Digit Span (Removed, Unavailable)
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
Temporal Order (Removed, Unavailable)
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
N-Back (Removed, Unavailable)
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
Trails B Dot Touch (Removed, Unavailable)
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
Jewels Trails A & B
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
Jewels Trails A & 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.
  1. tilt
    1. roll: number
    2. pitch: number
    3. yaw: number
  2. rotation
    1. x: number
    2. y: number
    3. z: number
  3. gravity
    1. x: number
    2. y: number
    3. z: number
  4. user_accel
    1. x: number
    2. y: number
    3. z: number
  5. magnetic_field
    1. x: number
    2. y: number
    3. z: number
    4. calibration: number
lamp.analytics: records events such as page opens, notification receipt, or login sessions.
  1. This data type is currently for internal use only.
  2. event_name: string
  3. event_payload: any
lamp.blood_pressure: records blood pressure from an external connected monitor.
  1. value: number
  2. units: string
lamp.calls: records calls after encrypting the phone number.
  1. phone_number: string
  2. duration: number
  3. call_type: string<incoming, outgoing, missed, busy>
lamp.distance: records total distance moved.
  1. value: number
  2. units: string
lamp.bluetooth: records bluetooth devices within range as well as signal strength.
  1. device_id: string
  2. frequency: number
  3. rssi: number
lamp.flights: records stairs of flights climbed.
  1. value: number
  2. units: string
lamp.height: records self-reported height.
  1. value: number
  2. units: string
lamp.magnetometer: records triaxial magnetic field changes.
  1. x: number
  2. y: number
  3. z: number
lamp.respiratory_rate: records respiratory rate from an external connected monitor.
  1. value: number
  2. units: string
lamp.heart_rate: records heart rate from an external connected monitor.
  1. value: number
  2. units: string
lamp.segment: records workout segment duration and length.
  1. value: number
  2. units: string
lamp.gyroscope: records unprocessed triaxial gyroscope data.
  1. x: number
  2. y: number
  3. z: number
lamp.sms: records text messages after encrypting the phone number.
  1. phone_number: string
  2. length: integer
  3. sms_type: string<sent, received>
lamp.sleep: records sleep duration with start and stop times.
  1. value: number
  2. units: string
lamp.weight: records self-reported weight, or weight from an external connected monitor.
  1. value: number
  2. units: string
lamp.steps: records number of steps taken since last such event, or the start of the day.
  1. value: number
  2. units: string
lamp.wifi: records encrypted wireless hotspots as well as signal strength.
  1. device_id: string
  2. frequency: number
  3. 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.