FAQs

How do I log into the MC10 API?

See Authentication.

How do I download “raw” recording data?

There are two ways to download "raw" recording data:

  1. As JSON, by subject. You can request small chunks of recording data in JSON format via the Get Recording Data endpoint. You must supply a study ID, subject ID and time boundaries. (Time boundaries might correspond to an activity or survey completed by a subject, which you can determine via the Get Annotations endpoint.)

  2. As CSV, by recording. You can download an entire recording in CSV format. First, identify the specific recording via the Get Recording Metadata for Subject endpoint. Then make another API request using the export link corresponding to that recording. This request returns a signed URL with an expiration timestamp. Follow the signed URL to download the file.

How much raw recording data can I expect to accrue over the course of a study?

The total volume of raw recording data depends on several factors: the number of subjects, the number of sensors per subject, the configuration of each sensor, and the duration of the study. A typical longitudinal study in the remote (home) environment might accrue several hundred gigabytes or more of raw data. See Working with CSV Data for more information.

How do I download “analytics” data (for studies using analytics)?

There are three ways to download analytics data:

  1. As JSON, by subject. You can request daily and intraday metrics for a single subject in JSON format via the Get Metrics and Get Channels endpoints.

  2. As CSV, for all subjects. You can download daily metrics for all subjects at once in CSV format via the Request Export File endpoint.

  3. As CSV, by subject. You can download daily and intraday metrics for a single subject in CSV format via the Download Metrics CSV and Download Channels CSV endpoints.

How do I get a list of all subjects in a study?

Use the Get Subjects endpoint.

How do I get a list of activities and surveys completed by a subject?

Use the Get Annotations endpoint and filter by "activity" and/or "diary". Or use the Download Annotations CSV endpoint to download annotations in CSV format.

How do I count the number of activities and surveys completed by a subject as part of a remote program?

Use the Get Task Completion Stats for Subject or Get Task Completion Details for Subject endpoint.

What types of survey questions are available?

There are nine types of survey questions. These can be delivered in a standalone survey or at the end of an activity. All responses to survey questions are expressed as strings when you request them through the API. Sample responses are shown in parentheses, below.

  • BOOLEAN. Yes/No question. ("YES" or "NO")

  • NUMERIC. Typed number entry. ("99")

  • RANGE. Discrete integer options, e.g. 1, 2, 3, 4, 5. ("5")

  • SLIDER. Continuous sliding scale with left and right labels (e.g. "Not Painful" and "Extremely Painful") that map to a value between 0 and 1. ("0.66")

  • TIMEOFDAY. Time of day entry. ("12:30 PM")

  • DURATION. Duration of time in hours, minutes, seconds and milliseconds. ("00:01:30.000")

  • MULTIPLECHOICE. Single selection by radio button. ("Red")

  • OPTIONS. Multiple selection by checkbox. ("Red;Yellow;Blue")

  • FREETEXT. Free text entry. ("Love this survey!")

How do I get a log of important events in a study?

Use the Get Events endpoint.

How do I associate a subject in this system to the same subject in another system?

There are a few ways to link records between systems:

  1. Use the displayName property of the subject (it appears as "Subject ID" in BioStamp® nPoint™). For example, you would enter "S-001" in both systems.

  2. Use a custom metadata field of the subject (these fields are first defined on the study). As above, you would enter "S-001" in both systems.

  3. Determine the subject id (a 128-bit universally unique ID) via the Get Subject endpoint or Get Subjects endpoint, then copy it from this system into the other system.

Can I create a study through this API?

No. At this time, studies must be created through the BioStamp® nPoint™ Investigator Portal.

Can I integrate with CTMS / EDC systems?

Yes. Third-party partners with study access credentials can interface directly with our API to ingest data into their systems.

MC10 can also push data into other systems via webhooks.