OpenDream Data Interface
OpenDream's data is what research and insights are built upon — they are the foundational elements of your studies and analyses with OpenDream datasets. On this page, we'll explore the different endpoints you can use to manage OpenDream data programmatically. We'll uncover how to query, send, update, and delete data records.
The Data Model
The data model encompasses all information about the records and datasets you interface with, including how they've been labeled, categorized, and utilized.
Properties
- Name
id- Type
- string
- Description
Unique identifier for the data record.
- Name
dataset_id- Type
- string
- Description
Unique identifier for the dataset the record is part of.
- Name
type- Type
- string
- Description
The type of data (e.g., EEG, FMRI).
- Name
labels- Type
- array
- Description
An array of labels associated with the data.
- Name
timestamp- Type
- timestamp
- Description
Timestamp of when the data was recorded.
- Name
quality- Type
- string
- Description
Quality rating of the data.
- Name
link- Type
- url
- Description
URL link to the raw data file or visualization.
List All Data Records
This endpoint lets you retrieve a paginated list of all your data records (filtered by dataset if a dataset id is provided). By default, a maximum of ten records are shown per page.
Optional attributes
- Name
dataset_id- Type
- string
- Description
Limit to records from a particular dataset.
- Name
limit- Type
- integer
- Description
Limit the number of records returned.