POST
/
v3
/
measurements
/
post
Save measurements
curl --request POST \
  --url https://safe.dfda.earth/api/v3/measurements/post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "startAt": "2022-01-01T00:00:00",
    "value": "3",
    "variableCategoryName": "Emotions",
    "variableName": "Overall Mood",
    "unitAbbreviatedName": "/5",
    "combinationOperation": "Mean",
    "sourceName": "<string>",
    "upc": "<string>",
    "note": "<string>"
  }
]'
{
  "data": {
    "userVariables": [
      "<any>"
    ],
    "description": "<string>",
    "summary": "<string>",
    "errors": [
      {
        "message": "<string>"
      }
    ],
    "status": "<string>",
    "success": true,
    "code": 123,
    "link": "<string>",
    "card": {
      "actionSheetButtons": [
        {
          "accessibilityText": "<string>",
          "action": {},
          "additionalInformation": "<string>",
          "color": "<string>",
          "confirmationText": "<string>",
          "functionName": "<string>",
          "parameters": {},
          "html": "<string>",
          "id": "<string>",
          "image": "<string>",
          "ionIcon": "<string>",
          "link": "<string>",
          "stateName": "<string>",
          "stateParams": {},
          "successToastText": "<string>",
          "successAlertTitle": "<string>",
          "successAlertBody": "<string>",
          "text": "<string>",
          "tooltip": "<string>",
          "webhookUrl": "<string>"
        }
      ],
      "avatar": "<string>",
      "avatarCircular": "<string>",
      "backgroundColor": "<string>",
      "buttons": [
        {
          "accessibilityText": "<string>",
          "action": {},
          "additionalInformation": "<string>",
          "color": "<string>",
          "confirmationText": "<string>",
          "functionName": "<string>",
          "parameters": {},
          "html": "<string>",
          "id": "<string>",
          "image": "<string>",
          "ionIcon": "<string>",
          "link": "<string>",
          "stateName": "<string>",
          "stateParams": {},
          "successToastText": "<string>",
          "successAlertTitle": "<string>",
          "successAlertBody": "<string>",
          "text": "<string>",
          "tooltip": "<string>",
          "webhookUrl": "<string>"
        }
      ],
      "buttonsSecondary": [
        {
          "accessibilityText": "<string>",
          "action": {},
          "additionalInformation": "<string>",
          "color": "<string>",
          "confirmationText": "<string>",
          "functionName": "<string>",
          "parameters": {},
          "html": "<string>",
          "id": "<string>",
          "image": "<string>",
          "ionIcon": "<string>",
          "link": "<string>",
          "stateName": "<string>",
          "stateParams": {},
          "successToastText": "<string>",
          "successAlertTitle": "<string>",
          "successAlertBody": "<string>",
          "text": "<string>",
          "tooltip": "<string>",
          "webhookUrl": "<string>"
        }
      ],
      "content": "<string>",
      "headerTitle": "<string>",
      "html": "<string>",
      "htmlContent": "<string>",
      "id": "<string>",
      "image": "<string>",
      "inputFields": [
        {
          "displayName": "<string>",
          "helpText": "<string>",
          "hint": "<string>",
          "icon": "<string>",
          "id": "<string>",
          "image": "<string>",
          "key": "<string>",
          "labelLeft": "<string>",
          "labelRight": "<string>",
          "link": "<string>",
          "maxLength": 123,
          "maxValue": 123,
          "minLength": 123,
          "minValue": 123,
          "options": [
            "<string>"
          ],
          "placeholder": "<string>",
          "postUrl": "<string>",
          "required": true,
          "show": true,
          "submitButton": {
            "accessibilityText": "<string>",
            "action": {},
            "additionalInformation": "<string>",
            "color": "<string>",
            "confirmationText": "<string>",
            "functionName": "<string>",
            "parameters": {},
            "html": "<string>",
            "id": "<string>",
            "image": "<string>",
            "ionIcon": "<string>",
            "link": "<string>",
            "stateName": "<string>",
            "stateParams": {},
            "successToastText": "<string>",
            "successAlertTitle": "<string>",
            "successAlertBody": "<string>",
            "text": "<string>",
            "tooltip": "<string>",
            "webhookUrl": "<string>"
          },
          "type": "check_box",
          "validationPattern": "<string>",
          "value": "<string>"
        }
      ],
      "ionIcon": "<string>",
      "link": "<string>",
      "parameters": {},
      "selectedButton": {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      },
      "sharingBody": "<string>",
      "sharingButtons": [
        {
          "accessibilityText": "<string>",
          "action": {},
          "additionalInformation": "<string>",
          "color": "<string>",
          "confirmationText": "<string>",
          "functionName": "<string>",
          "parameters": {},
          "html": "<string>",
          "id": "<string>",
          "image": "<string>",
          "ionIcon": "<string>",
          "link": "<string>",
          "stateName": "<string>",
          "stateParams": {},
          "successToastText": "<string>",
          "successAlertTitle": "<string>",
          "successAlertBody": "<string>",
          "text": "<string>",
          "tooltip": "<string>",
          "webhookUrl": "<string>"
        }
      ],
      "sharingTitle": "<string>",
      "subHeader": "<string>",
      "subTitle": "<string>",
      "title": "<string>"
    }
  },
  "message": "<string>",
  "description": "<string>",
  "summary": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "status": "<string>",
  "success": true,
  "code": 123,
  "card": {
    "actionSheetButtons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "avatar": "<string>",
    "avatarCircular": "<string>",
    "backgroundColor": "<string>",
    "buttons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "buttonsSecondary": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "content": "<string>",
    "headerTitle": "<string>",
    "html": "<string>",
    "htmlContent": "<string>",
    "id": "<string>",
    "image": "<string>",
    "inputFields": [
      {
        "displayName": "<string>",
        "helpText": "<string>",
        "hint": "<string>",
        "icon": "<string>",
        "id": "<string>",
        "image": "<string>",
        "key": "<string>",
        "labelLeft": "<string>",
        "labelRight": "<string>",
        "link": "<string>",
        "maxLength": 123,
        "maxValue": 123,
        "minLength": 123,
        "minValue": 123,
        "options": [
          "<string>"
        ],
        "placeholder": "<string>",
        "postUrl": "<string>",
        "required": true,
        "show": true,
        "submitButton": {
          "accessibilityText": "<string>",
          "action": {},
          "additionalInformation": "<string>",
          "color": "<string>",
          "confirmationText": "<string>",
          "functionName": "<string>",
          "parameters": {},
          "html": "<string>",
          "id": "<string>",
          "image": "<string>",
          "ionIcon": "<string>",
          "link": "<string>",
          "stateName": "<string>",
          "stateParams": {},
          "successToastText": "<string>",
          "successAlertTitle": "<string>",
          "successAlertBody": "<string>",
          "text": "<string>",
          "tooltip": "<string>",
          "webhookUrl": "<string>"
        },
        "type": "check_box",
        "validationPattern": "<string>",
        "value": "<string>"
      }
    ],
    "ionIcon": "<string>",
    "link": "<string>",
    "parameters": {},
    "selectedButton": {
      "accessibilityText": "<string>",
      "action": {},
      "additionalInformation": "<string>",
      "color": "<string>",
      "confirmationText": "<string>",
      "functionName": "<string>",
      "parameters": {},
      "html": "<string>",
      "id": "<string>",
      "image": "<string>",
      "ionIcon": "<string>",
      "link": "<string>",
      "stateName": "<string>",
      "stateParams": {},
      "successToastText": "<string>",
      "successAlertTitle": "<string>",
      "successAlertBody": "<string>",
      "text": "<string>",
      "tooltip": "<string>",
      "webhookUrl": "<string>"
    },
    "sharingBody": "<string>",
    "sharingButtons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "sharingTitle": "<string>",
    "subHeader": "<string>",
    "subTitle": "<string>",
    "title": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Enter your bearer token in the format Bearer access_token_here

Body

application/json · object[]

An array of measurement sets containing measurement items you want to insert.

​
startAt
string
default:2022-01-01T00:00:00
required

Start Time for the measurement event in UTC ISO 8601 like 2020-01-01T12:12:12

​
value
number
default:3
required

Measurement value

​
variableCategoryName
enum<string>
default:Emotions
required

Ex: Emotions, Treatments, Symptoms...

Available options:
Activity,
Books,
Causes of Illness,
Cognitive Performance,
Conditions,
Emotions,
Environment,
Foods,
Goals,
Locations,
Miscellaneous,
Movies and TV,
Music,
Nutrients,
Payments,
Physical Activities,
Physique,
Sleep,
Social Interactions,
Software,
Symptoms,
Treatments,
Vital Signs
​
variableName
string
default:Overall Mood
required

Name of the variable for which we are creating the measurement records

​
unitAbbreviatedName
string
default:/5
required

Unit of measurement

​
combinationOperation
enum<string>
default:Mean
required

Way to aggregate measurements over time. SUM should be used for things like minutes of exercise. If you use MEAN for exercise, then a person might exercise more minutes in one day but add separate measurements that were smaller. So when we are doing correlational analysis, we would think that the person exercised less that day even though they exercised more. Conversely, we must use MEAN for things such as ratings which cannot be SUMMED.

Available options:
MEAN,
SUM
​
sourceName
string

Name of the application or device used to record the measurement values

​
upc
string

UPC or other barcode scan result if you want to attach it to the variable name for recording measurements with a UPC scanner

​
note
string

Optional note to include with the measurement

Response

Successful operation

​
status
string
required

ex. OK or ERROR

​
success
boolean
required

true or false

​
data
object
​
message
string

Message

​
description
string

Can be used as body of help info popup

​
summary
string

Can be used as title in help info popup

​
errors
object[]

Array of error objects with message property

​
code
number

Response code such as 200

​
card
object