API Overview

Back End Authentication for Creating Users

Community

News

Code

The Decentralized FDA

API Reference

Dashboard

Support

Introduction to the dFDA API and how to get started

Getting Started

Introduction

This is the first step to interact with the dFDA API. Learn how to create a user and get an access token.

Getting an Access Token

Variables are things like treatments or symptoms and include analysis settings and statistics.

Get User Variables

See how to save treatments or symptom ratings for a user

Record Measurements

Development

Users can delete all of their measurements for a variable

Delete All Measurements For Variable

Delete previously created user tags or ingredients.

Delete user tag or ingredient

Get user variables settings and statistics. If the user has specified variable settings, these are provided instead of the common variable defaults.

Get user variables

This endpoint allows users to tag foods with their ingredients.  This information will then be used to infer the user intake of the different ingredients by just entering the foods. The inferred intake levels will then be used to determine the effects of different nutrients on the user during analysis.

Post or update user tags or ingredients

Reset user settings for a variable to defaults

Users can change the parameters used in analysis of that variable such as the expected duration of action for a variable to have an effect, the estimated delay before the onset of action. In order to filter out erroneous data, they are able to set the maximum and minimum reasonable daily values for a variable.

Update User Settings for a Variable

The variable categories include Activity, Causes of Illness, Cognitive Performance, Conditions, Environment, Foods, Location, Miscellaneous, Mood, Nutrition, Physical Activity, Physique, Sleep, Social Interactions, Symptoms, Treatments, Vital Signs, and Goals.

Variable categories

Store measurements representing things like a food eaten, a mood rating, or a medication taken. If the variable for the measurements does not already exist in the database, it will be automatically created.

Save measurements

Delete a previously submitted measurement

Delete a measurement

Measurements are any value that can be recorded like daily steps, a mood rating, or apples eaten.

Get measurements

Use this endpoint to schedule a CSV export containing all user measurements to be emailed to the user within 24 hours.

Post Request for Measurements CSV

Update a previously submitted measurement

Update a measurement

Import from a spreadsheet containing a Variable Name, Value, Measurement Event Time, and Abbreviated Unit Name field.  Here is an <a href="https://bit.ly/2jz7CNl" target="_blank">example spreadsheet</a> with allowed column names, units and time format.

Upload a spreadsheet with measurements

Get a list of user variable relationships that can be used to display top predictors of a given outcome like mood, for instance.

Get user variable relationships

Get the settings for your application configurable at https://builder.quantimo.do

Get client app settings

A connector pulls data from other data providers using their API or a screenscraper. Returns a list of all available connectors and information about them such as their id, name, whether the user has provided access, logo url, connection instructions, and the update history.

List Data Sources

The disconnect method deletes any stored tokens or connection information from the connectors database.

Disconnect Data Source

Attempt to obtain a token from the data provider, store it in the database. With this, the connector to continue to obtain new user data until the token is revoked.

Connect Data Source

Trigger an import from the data provider (such as Fitbit or MyFitnessPal) and retrieve any new measurements available.

Sync Data Source

Post user interactions with feed

Tracking reminder notifications, messages, and study results

Get NotificationPreferences

Post user token for Android, iOS, or web push notifications

Post DeviceTokens

Stop getting notifications to record data for a variable.  Previously recorded measurements will be preserved.

Delete Tracking Reminder

Users can be reminded to track certain variables at a specified frequency with a default value.

Get tracking reminder settings

Specific tracking reminder notification instances that still need to be tracked.

Get tracking reminder notifications

Snooze, skip, or track a tracking reminder notification

This is to enable users to create reminders to track a variable with a default value at a specified frequency

Create or Update Tracking Reminder

Remove access to user data for a given client_id associated with a given individual, app, or study

Delete share

This is a list of individuals, apps, or studies with access to your measurements.

Get Authorized Apps, Studies, and Individuals

Create an individual, group, or population study examining the relationship between a predictor and outcome variable. You will be given a study id which you can invite participants to join and share their measurements for the specified variables.

Create a Study

Delete vote

If you have enough data, this will be a list of your personal studies, otherwise it will consist of aggregated population studies.

Get Personal or Population Studies

Get studies you have created

Get Study

Anonymously share measurements for specified variables

Join a Study

I am really good at finding user_variable_relationships and even compensating for various onset delays and durations of action. However, you are much better than me at knowing if there's a way that a given factor could plausibly influence an outcome. You can help me learn and get better at my predictions by pressing the thumbs down button for relationships that you think are coincidences and thumbs up once that make logic sense.

Post or update vote

Make a study and all related measurements publicly visible by anyone

Publish Your Study

These are studies that you are currently sharing your data with.

Studies You Have Joined

These are studies that anyone can join and share their data for the predictor and outcome variables of interest.

Get Open Studies

Get a list of the categories of measurement units such as 'Distance', 'Duration', 'Energy', 'Frequency', 'Miscellany', 'Pressure', 'Proportion', 'Rating', 'Temperature', 'Volume', and 'Weight'.

Get unit categories

Get a list of the available measurement units

Get units

Include your your system's user id as the clientUserId to make sure you can identify the user in your system. If the user already exists, the user will be updated with the new information.

Create or update user

Returns user info.  If no userId is specified, returns info for currently authenticated user

Get user info

Delete user account. Only the client app that created a user can delete that user.

Delete user

Returns users who have granted access to their data

API Reference

Getting Started

API Overview

dFDA API Specification

Back End Authentication for Creating Users

Authentication Guide

API Reference

​API Overview

dFDA API Specification

​Back End Authentication for Creating Users

Authentication Guide

API Overview

Back End Authentication for Creating Users