Studies

A study defines how to collect both physiological data (e.g. biopotential) and contextual data (e.g. survey responses) from subjects using BioStamp® sensors and associated applications.

Get Studies

Get a list of studies for an account.

URL

GET https://mc10cloud.com/api/v1/accounts/{accountId}/studies

Parameters

  • accountId: Account UUID

Sample Response

The following example shows two studies, one complete and one in progress (possible states are "INITIALIZED", "IN_PROGRESS" and "COMPLETE"). The second study shows four custom metadata fields.

Each study may include a reference to an "export" file, if one has been generated. This is not the location of the export file itself. Rather, it is an API endpoint that returns a signed URL. Follow the signed URL to download a ZIP file containing study metadata and analytics in CSV format.

[
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"createdTs": 1501252491814,
"displayName": "MC10-PTL-101",
"export": {
"href": "/v1/archives/ea6eac60-73a1-11e7-a5b3-0a84ea04a300/href",
"requestedTs": 1527883949488,
"sizeBytes": 681746
},
"id": "ea6eac60-73a1-11e7-a5b3-0a84ea04a300",
"isArchived": false,
"lifecycleState": "COMPLETE",
"subjectMetadataFields": [],
"title": "Internal validation trial for protocol PTL-101"
},
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"createdTs": 1525381210566,
"displayName": "MC10-PTL-102",
"export": {
"href": "/v1/archives/f7888660-4f14-11e8-a47c-028eb5a65596/href",
"requestedTs": 1551467059537,
"sizeBytes": 407902
},
"id": "f7888660-4f14-11e8-a47c-028eb5a65596",
"isArchived": false,
"lifecycleState": "IN_PROGRESS",
"subjectMetadataFields": [
{
"displayName": "Dominant Hand",
"type": "MULTIPLECHOICE",
"values": [
"Left",
"Right"
]
},
{
"displayName": "Employee ID",
"type": "FREETEXT",
"values": []
},
{
"displayName": "Skin Type",
"type": "NUMBER",
"values": []
},
{
"displayName": "Informed Consent",
"type": "BOOLEAN",
"values": [
"YES",
"NO"
]
}
],
"title": "Internal validation trial for protocol PTL-102"
}
]

Get Study

Get a specific study by ID. As a convenience, this endpoint includes a full list of subjects in the study.

URL

GET https://mc10cloud.com/api/v1/studies/{studyId}

Parameters

  • studyId: Study UUID

Sample Response

The following example shows a study with one activity, one survey ("diary"), three device configurations, and an export.

The "export" reference is not the location of the export file itself. Rather, it is an API endpoint that returns a signed URL. Follow the signed URL to download a ZIP file containing study metadata and analytics in CSV format.

{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"activities": [
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"createdTs": 1525381210591,
"displayName": "Walking",
"durationSec": 180,
"id": "f78c5700-4f14-11e8-a47c-028eb5a65596",
"instructions": "Walk at a comfortable pace for 3 minutes.",
"mode": "UNSUPERVISED",
"modifiedTs": 1525381239651,
"order": 105270474,
"pipelineIds": [],
"questions": [
{
"createdTs": 1525381239651,
"id": "08de8b30-4f15-11e8-bd02-0a84ea04a300",
"text": "What was your walking pace?",
"type": "MULTIPLECHOICE",
"values": [
"Slow",
"Medium",
"Fast"
]
},
{
"createdTs": 1525381239651,
"id": "08de8b32-4f15-11e8-bd02-0a84ea04a300",
"text": "How tired are you on a scale of 0 (Not at all) to 10 (Extremely)?",
"type": "RANGE",
"values": [
"0",
"10"
]
},
{
"createdTs": 1525381239651,
"id": "08de8b33-4f15-11e8-bd02-0a84ea04a300",
"text": "Did you stop at any time during your walk?",
"type": "BOOLEAN",
"values": [
"YES",
"NO"
]
}
],
"studyId": "f7888660-4f14-11e8-a47c-028eb5a65596"
}
],
"createdTs": 1525381210566,
"deviceConfigs": [
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"createdTs": 1525381210591,
"id": "f78c5718-4f14-11e8-a47c-028eb5a65596",
"mode": "UNSUPERVISED",
"modifiedTs": 1525381210566,
"physicalConfig": {
"location": "FLEXOR_DIGITORUM",
"side": "DOMINANT",
"signal": "EMG"
},
"pipelineIds": [],
"sensorConfig": {
"afe": {
"gain": 12,
"rate": 250
},
"gyro": {
"accelLowPower": true,
"accelRange": 4,
"gyroAutoCalib": false,
"mode": "ACCEL",
"periodMs": 32
},
"sensingType": "MPU_ANALOG"
},
"studyId": "f7888660-4f14-11e8-a47c-028eb5a65596"
},
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"createdTs": 1525381210591,
"id": "f78c5717-4f14-11e8-a47c-028eb5a65596",
"mode": "UNSUPERVISED",
"modifiedTs": 1525381210566,
"physicalConfig": {
"location": "ANTERIOR_THIGH",
"side": "ANY"
},
"pipelineIds": [
"f78970c0-4f14-11e8-a47c-028eb5a65596"
],
"sensorConfig": {
"gyro": {
"accelLowPower": true,
"accelRange": 16,
"gyroAutoCalib": false,
"mode": "ACCEL",
"periodMs": 32
},
"sensingType": "MPU"
},
"sourceId": "1a45a12b-d81e-11e6-95ed-34363bc793c4",
"studyId": "f7888660-4f14-11e8-a47c-028eb5a65596"
},
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"createdTs": 1525381210591,
"id": "f78c5716-4f14-11e8-a47c-028eb5a65596",
"mode": "UNSUPERVISED",
"modifiedTs": 1525381210566,
"physicalConfig": {
"location": "ECG_LEAD_II",
"side": "NONE",
"signal": "ECG"
},
"pipelineIds": [
"f78970c0-4f14-11e8-a47c-028eb5a65596"
],
"sensorConfig": {
"afe": {
"gain": 12,
"rate": 250
},
"gyro": {
"accelLowPower": true,
"accelRange": 16,
"gyroAutoCalib": false,
"mode": "ACCEL",
"periodMs": 32
},
"sensingType": "MPU_ANALOG"
},
"sourceId": "a6a02d59-d77b-11e6-a460-34363bc793c4",
"studyId": "f7888660-4f14-11e8-a47c-028eb5a65596"
}
],
"diaries": [
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"createdTs": 1525471596625,
"displayName": "Sleep Survey",
"id": "69d29c15-4fe7-11e8-a47c-028eb5a65596",
"mode": "UNSUPERVISED",
"modifiedTs": 1525471650690,
"order": 105383196,
"pipelineIds": [],
"questions": [
{
"createdTs": 1525471650690,
"id": "8a0c4620-4fe7-11e8-a47c-028eb5a65596",
"text": "Did you sleep well last night?",
"type": "BOOLEAN",
"values": [
"YES",
"NO"
]
},
{
"createdTs": 1525471650690,
"id": "8a0c4621-4fe7-11e8-a47c-028eb5a65596",
"text": "How many times did you wake up or get up during the night?",
"type": "NUMERIC",
"values": []
},
{
"createdTs": 1525471650690,
"id": "8a0c4622-4fe7-11e8-a47c-028eb5a65596",
"text": "What time did you wake up this morning?",
"type": "TIMEOFDAY",
"values": []
},
{
"createdTs": 1525471650690,
"id": "8a0c4623-4fe7-11e8-a47c-028eb5a65596",
"text": "Rate your sleep quality on a scale of 0 (Awful) to 10 (Amazing).",
"type": "RANGE",
"values": [
"0",
"10"
]
}
],
"studyId": "f7888660-4f14-11e8-a47c-028eb5a65596"
}
],
"displayName": "MC10-PTL-102",
"export": {
"href": "/v1/archives/f7888660-4f14-11e8-a47c-028eb5a65596/href",
"requestedTs": 1551467059537,
"sizeBytes": 407902
},
"id": "f7888660-4f14-11e8-a47c-028eb5a65596",
"isArchived": false,
"lifecycleState": "IN_PROGRESS",
"pipelines": [ ... ],
"program": { ... },
"subjectMetadataFields": [
{
"displayName": "Dominant Hand",
"type": "MULTIPLECHOICE",
"values": [
"Left",
"Right"
]
},
{
"displayName": "Employee ID",
"type": "FREETEXT",
"values": []
},
{
"displayName": "Skin Type",
"type": "NUMBER",
"values": []
},
{
"displayName": "Informed Consent",
"type": "BOOLEAN",
"values": [
"YES",
"NO"
]
}
],
"subjects": [ ... ],
"title": "Internal validation trial for protocol PTL-102"
}

Request Export File

Request a new "export" ZIP file, which contains study metadata and analytics for all subjects as of the time requested, in CSV format. This endpoint returns no data; rather, the system will send you an email when the export file is ready, typically within a few minutes.

To retrieve the export file itself, make a request to Get Study and follow the "export" link. The "export" link is an API endpoint that returns a signed URL. Follow the signed URL to download the file.

URL

POST https://mc10cloud.com/api/v1/archives/${studyId}/archive

Parameters

  • studyId: Study UUID

Sample Response

(No Response)