GET
/
v3
/
trackingReminders
curl --request GET \
  --url https://safe.dfda.earth/api/v3/trackingReminders \
  --header 'Authorization: Bearer <token>'
[
  {
    "actionArray": [
      {
        "action": "<string>",
        "callback": "<string>",
        "modifiedValue": 123,
        "title": "<string>",
        "longTitle": "<string>",
        "shortTitle": "<string>"
      }
    ],
    "availableUnits": [
      {
        "abbreviatedName": "<string>",
        "advanced": 123,
        "category": "Distance",
        "categoryId": 123,
        "categoryName": "<string>",
        "conversionSteps": [
          {
            "operation": "ADD",
            "value": 123
          }
        ],
        "id": 123,
        "image": "<string>",
        "manualTracking": 123,
        "maximumAllowedValue": 123,
        "maximumValue": 123,
        "minimumAllowedValue": 123,
        "minimumValue": 123,
        "name": "<string>",
        "unitCategory": {
          "id": 123,
          "name": "<string>",
          "standardUnitAbbreviatedName": "<string>"
        }
      }
    ],
    "bestStudyLink": "<string>",
    "bestUserStudyLink": "<string>",
    "bestPopulationStudyLink": "<string>",
    "optimalValueMessage": "<string>",
    "commonOptimalValueMessage": "<string>",
    "userOptimalValueMessage": "<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>"
    },
    "clientId": "<string>",
    "combinationOperation": "MEAN",
    "createdAt": "<string>",
    "displayName": "<string>",
    "unitAbbreviatedName": "<string>",
    "unitCategoryId": 123,
    "unitCategoryName": "<string>",
    "unitId": 123,
    "unitName": "<string>",
    "defaultValue": 123,
    "enabled": true,
    "email": true,
    "errorMessage": "<string>",
    "fillingValue": 123,
    "firstDailyReminderTime": "<string>",
    "frequencyTextDescription": "<string>",
    "frequencyTextDescriptionWithTime": "<string>",
    "id": 123,
    "inputType": "<string>",
    "instructions": "<string>",
    "ionIcon": "<string>",
    "lastTracked": "<string>",
    "lastValue": 123,
    "latestTrackingReminderNotificationReminderTime": "<string>",
    "localDailyReminderNotificationTimes": [
      "<string>"
    ],
    "localDailyReminderNotificationTimesForAllReminders": [
      "<string>"
    ],
    "manualTracking": true,
    "maximumAllowedValue": 123,
    "minimumAllowedValue": 123,
    "nextReminderTimeEpochSeconds": 123,
    "notificationBar": true,
    "numberOfRawMeasurements": 123,
    "numberOfUniqueValues": 123,
    "outcome": true,
    "pngPath": "<string>",
    "pngUrl": "<string>",
    "productUrl": "<string>",
    "popUp": true,
    "question": "<string>",
    "longQuestion": "<string>",
    "reminderEndTime": "<string>",
    "reminderFrequency": 123,
    "reminderSound": "<string>",
    "reminderStartEpochSeconds": 123,
    "reminderStartTime": "<string>",
    "reminderStartTimeLocal": "<string>",
    "reminderStartTimeLocalHumanFormatted": "<string>",
    "repeating": true,
    "secondDailyReminderTime": "<string>",
    "secondToLastValue": 123,
    "sms": true,
    "startTrackingDate": "<string>",
    "stopTrackingDate": "<string>",
    "svgUrl": "<string>",
    "thirdDailyReminderTime": "<string>",
    "thirdToLastValue": 123,
    "trackingReminderId": 123,
    "trackingReminderImageUrl": "<string>",
    "upc": "<string>",
    "updatedAt": "<string>",
    "userId": 123,
    "userVariableUnitAbbreviatedName": "<string>",
    "userVariableUnitCategoryId": 123,
    "userVariableUnitCategoryName": "<string>",
    "userVariableUnitId": 123,
    "userVariableUnitName": "<string>",
    "userVariableVariableCategoryId": 123,
    "userVariableVariableCategoryName": "<string>",
    "valence": "<string>",
    "valueAndFrequencyTextDescription": "<string>",
    "valueAndFrequencyTextDescriptionWithTime": "<string>",
    "variableCategoryId": 123,
    "variableCategoryImageUrl": "<string>",
    "variableCategoryName": "Activity",
    "variableDescription": "<string>",
    "variableId": 123,
    "variableName": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Enter your bearer token in the format Bearer access_token_here

Query Parameters

​
variableCategoryName
enum<string>

Ex: Emotions, Treatments, Symptoms...

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

When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

​
updatedAt
string

When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

​
limit
integer
default:
100

The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.

​
offset
integer

OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.

Required range: x >= 0
​
sort
string

Sort by one of the listed field names. If the field name is prefixed with -, it will sort in descending order.

​
clientId
string

Your client id can be obtained by creating an app at https://builder.quantimo.do

Response

200 - application/json
Successful operation
​
unitAbbreviatedName
string
required

Ex: /5

​
reminderFrequency
integer
required

Number of seconds between one reminder and the next

​
variableCategoryName
enum<string>
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
required

Name of the variable to be used when sending measurements

​
actionArray
object[]
​
availableUnits
object[]
​
bestStudyLink
string

Link to study comparing variable with strongest relationship for user or population

​
bestUserStudyLink
string

Link to study comparing variable with strongest relationship for user

​
bestPopulationStudyLink
string

Link to study comparing variable with strongest relationship for population

​
optimalValueMessage
string

Description of relationship with variable with strongest relationship for user or population

​
commonOptimalValueMessage
string

Description of relationship with variable with strongest relationship for population

​
userOptimalValueMessage
string

Description of relationship with variable with strongest relationship for user

​
card
object
​
clientId
string

Your client id can be obtained by creating an app at https://builder.quantimo.do

​
combinationOperation
enum<string>

The way multiple measurements are aggregated over time

Available options:
MEAN,
SUM
​
createdAt
string

Ex: 2016-05-18 02:24:08 UTC ISO 8601 YYYY-MM-DDThh:mm:ss

​
displayName
string

Ex: Trader Joe's Bedtime Tea

​
unitCategoryId
integer

Ex: 5

​
unitCategoryName
string

Ex: Rating

​
unitId
integer

Ex: 10

​
unitName
string

Ex: 1 to 5 Rating

​
defaultValue
number

Default value to use for the measurement when tracking. Unit: User-specified or common.

​
enabled
boolean

If a tracking reminder is enabled, tracking reminder notifications will be generated for this variable.

​
email
boolean

True if the reminders should be delivered via email

​
errorMessage
string

Ex: reminderStartTimeLocal is less than $user->earliestReminderTime or greater than $user->latestReminderTime

​
fillingValue
integer

Ex: 0. Unit: User-specified or common.

​
firstDailyReminderTime
string

Ex: 02:45:20 in UTC timezone

​
frequencyTextDescription
string

Ex: Daily

​
frequencyTextDescriptionWithTime
string

Ex: Daily at 09:45 PM

​
id
integer

id

​
inputType
string

Ex: saddestFaceIsFive

​
instructions
string

Ex: I am an instruction!

​
ionIcon
string

Ex: ion-sad-outline

​
lastTracked
string

UTC ISO 8601 YYYY-MM-DDThh:mm:ss timestamp for the last time a measurement was received for this user and variable

​
lastValue
number

Ex: 2

​
latestTrackingReminderNotificationReminderTime
string

UTC ISO 8601 YYYY-MM-DDThh:mm:ss timestamp for the reminder time of the latest tracking reminder notification that has been pre-emptively generated in the database

​
localDailyReminderNotificationTimes
string[]
​
localDailyReminderNotificationTimesForAllReminders
string[]
​
manualTracking
boolean

Ex: 1

​
maximumAllowedValue
number

Ex: 5. Unit: User-specified or common.

​
minimumAllowedValue
number

Ex: 1. Unit: User-specified or common.

​
nextReminderTimeEpochSeconds
integer

Ex: 1501555520

​
notificationBar
boolean

True if the reminders should appear in the notification bar

​
numberOfRawMeasurements
integer

Ex: 445

​
numberOfUniqueValues
integer

Ex: 1

​
outcome
boolean

Indicates whether the variable is usually an outcome of interest such as a symptom or emotion

​
pngPath
string

Ex: img/variable_categories/symptoms.png

​
pngUrl
string

Ex: https://safe.dfda.earth/img/variable_categories/symptoms.png

​
productUrl
string

Link to associated product for purchase

​
popUp
boolean

True if the reminders should appear as a popup notification

​
question
string

Ex: How is your overall mood?

​
longQuestion
string

Ex: How is your overall mood on a scale of 1 to 5??

​
reminderEndTime
string

Latest time of day at which reminders should appear in UTC HH:MM:SS format

​
reminderSound
string

String identifier for the sound to accompany the reminder

​
reminderStartEpochSeconds
integer

Ex: 1469760320

​
reminderStartTime
string

Earliest time of day at which reminders should appear in UTC HH:MM:SS format

​
reminderStartTimeLocal
string

Ex: 21:45:20

​
reminderStartTimeLocalHumanFormatted
string

Ex: 09:45 PM

​
repeating
boolean

Ex: true

​
secondDailyReminderTime
string

Ex: 01:00:00

​
secondToLastValue
number

Ex: 1. Unit: User-specified or common.

​
sms
boolean

True if the reminders should be delivered via SMS

​
startTrackingDate
string

Earliest date on which the user should be reminded to track in YYYY-MM-DD format

​
stopTrackingDate
string

Latest date on which the user should be reminded to track in YYYY-MM-DD format

​
svgUrl
string

Ex: https://safe.dfda.earth/img/variable_categories/symptoms.svg

​
thirdDailyReminderTime
string

Ex: 20:00:00

​
thirdToLastValue
number

Ex: 3

​
trackingReminderId
integer

Ex: 11841

​
trackingReminderImageUrl
string

Ex: Not Found

​
upc
string

UPC or other barcode scan result

​
updatedAt
string

When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

​
userId
integer

ID of User

​
userVariableUnitAbbreviatedName
string

Ex: /5

​
userVariableUnitCategoryId
integer

Ex: 5

​
userVariableUnitCategoryName
string

Ex: Rating

​
userVariableUnitId
integer

Ex: 10

​
userVariableUnitName
string

Ex: 1 to 5 Rating

​
userVariableVariableCategoryId
integer

Ex: 10

​
userVariableVariableCategoryName
string

Ex: Symptoms

​
valence
string

Valence indicates what type of buttons should be used when recording measurements for this variable. positive - Face buttons with the happiest face equating to a 5/5 rating where higher is better like Overall Mood. negative - Face buttons with the happiest face equating to a 1/5 rating where lower is better like Headache Severity. numeric - Just 1 to 5 numeric buttons for neutral variables.

​
valueAndFrequencyTextDescription
string

Ex: Rate daily

​
valueAndFrequencyTextDescriptionWithTime
string

Ex: Rate daily at 09:45 PM

​
variableCategoryId
integer

Ex: 10

​
variableCategoryImageUrl
string

Ex: https://static.quantimo.do/img/variable_categories/sad-96.png

​
variableDescription
string

Valence indicates what type of buttons should be used when recording measurements for this variable. positive - Face buttons with the happiest face equating to a 5/5 rating where higher is better like Overall Mood. negative - Face buttons with the happiest face equating to a 1/5 rating where lower is better like Headache Severity. numeric - Just 1 to 5 numeric buttons for neutral variables.

​
variableId
integer

Id for the variable to be tracked

Delete Tracking ReminderGet tracking reminder notifications