Skip to content

Latest commit

 

History

History
92 lines (88 loc) · 8.94 KB

TrackingReminderNotification.md

File metadata and controls

92 lines (88 loc) · 8.94 KB
Raw

TrackingReminderNotification

Properties

Name Type Description Notes
action_array \QuantiModo\Client\Model\TrackingReminderNotificationAction[]
available_units \QuantiModo\Client\Model\Unit[]
best_study_link string Link to study comparing variable with strongest relationship for user or population [optional]
best_study_card \QuantiModo\Client\Model\Card Description of relationship with variable with strongest relationship for user or population [optional]
best_user_study_link string Link to study comparing variable with strongest relationship for user [optional]
best_user_study_card \QuantiModo\Client\Model\Card Description of relationship with variable with strongest relationship for user [optional]
best_population_study_link string Link to study comparing variable with strongest relationship for population [optional]
best_population_study_card \QuantiModo\Client\Model\Card Description of relationship with variable with strongest relationship for population [optional]
optimal_value_message string Description of relationship with variable with strongest relationship for user or population [optional]
common_optimal_value_message string Description of relationship with variable with strongest relationship for population [optional]
user_optimal_value_message string Description of relationship with variable with strongest relationship for user [optional]
card \QuantiModo\Client\Model\Card Card with options for tracking. [optional]
client_id string Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do [optional]
combination_operation string The way multiple measurements are aggregated over time [optional]
created_at string Ex: 2017-07-29 20:49:54 UTC ISO 8601 YYYY-MM-DDThh:mm:ss [optional]
display_name string Ex: Trader Joe's Bedtime Tea [optional]
modified_value double Is the user specified default value or falls back to the last value in user unit. Good for initializing input fields. Unit: User-specified or common. [optional]
unit_abbreviated_name string Ex: /5 [optional]
unit_category_id int Ex: 5 [optional]
unit_category_name string Ex: Rating [optional]
unit_id int Ex: 10 [optional]
unit_name string Ex: 1 to 5 Rating [optional]
default_value float Default value to use for the measurement when tracking [optional]
description 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 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. [optional]
email bool True if the reminders should be delivered via email [optional]
filling_value int Ex: 0
icon_icon string Ex: ion-sad-outline [optional]
id int id for the specific PENDING tracking remidner
image_url string Ex: https://rximage.nlm.nih.gov/image/images/gallery/original/55111-0129-60_RXNAVIMAGE10_B051D81E.jpg [optional]
input_type string Ex: happiestFaceIsFive [optional]
ion_icon string Ex: ion-happy-outline [optional]
last_value double Ex: 3 [optional]
manual_tracking bool True if this variable is normally tracked via manual user input rather than automatic imports [optional]
maximum_allowed_value int Ex: 5 [optional]
minimum_allowed_value int Ex: 1 [optional]
most_common_value double Ex: 3 [optional]
notification_bar bool True if the reminders should appear in the notification bar [optional]
notified_at string Ex: UTC ISO 8601 YYYY-MM-DDThh:mm:ss [optional]
number_of_unique_values int Ex: 5 [optional]
outcome bool Indicates whether or not the variable is usually an outcome of interest such as a symptom or emotion [optional]
png_path string Ex: img/variable_categories/emotions.png [optional]
png_url string Ex: https://web.quantimo.do/img/variable_categories/emotions.png [optional]
pop_up bool True if the reminders should appear as a popup notification [optional]
product_url string Link to associated product for purchase [optional]
question string Ex: How is your overall mood? [optional]
long_question string Ex: How is your overall mood on a scale of 1 to 5?? [optional]
reminder_end_time string Ex: 01-01-2018 [optional]
reminder_frequency int How often user should be reminded in seconds. Ex: 86400 [optional]
reminder_sound string String identifier for the sound to accompany the reminder [optional]
reminder_start_time string Earliest time of day at which reminders should appear in UTC HH:MM:SS format [optional]
reminder_time string UTC ISO 8601 YYYY-MM-DDThh:mm:ss timestamp for the specific time the variable should be tracked in UTC. This will be used for the measurement startTime if the track endpoint is used. [optional]
second_most_common_value double Ex: 4 [optional]
second_to_last_value double Ex: 1 [optional]
sms bool True if the reminders should be delivered via SMS [optional]
svg_url string Ex: https://web.quantimo.do/img/variable_categories/emotions.svg [optional]
third_most_common_value double Ex: 2 [optional]
third_to_last_value double Ex: 2 [optional]
title string Ex: Rate Overall Mood [optional]
total double Ex: 3 [optional]
track_all_actions \QuantiModo\Client\Model\TrackingReminderNotificationTrackAllAction[]
tracking_reminder_id int id for the repeating tracking remidner [optional]
tracking_reminder_image_url string Ex: https://rximage.nlm.nih.gov/image/images/gallery/original/55111-0129-60_RXNAVIMAGE10_B051D81E.jpg [optional]
tracking_reminder_notification_id int Ex: 5072482 [optional]
tracking_reminder_notification_time string UTC ISO 8601 YYYY-MM-DDThh:mm:ss timestamp for the specific time the variable should be tracked in UTC. This will be used for the measurement startTime if the track endpoint is used. [optional]
tracking_reminder_notification_time_epoch int Ex: 1501534124 [optional]
tracking_reminder_notification_time_local string Ex: 15:48:44 [optional]
tracking_reminder_notification_time_local_human_string string Ex: 8PM Sun, May 1 [optional]
updated_at 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. [optional]
user_id int ID of User [optional]
user_variable_unit_abbreviated_name string Ex: /5 [optional]
user_variable_unit_category_id int Ex: 5 [optional]
user_variable_unit_category_name string Ex: Rating [optional]
user_variable_unit_id int Ex: 10 [optional]
user_variable_unit_name string Ex: 1 to 5 Rating [optional]
user_variable_variable_category_id int Ex: 1 [optional]
user_variable_variable_category_name string Ex: Emotions [optional]
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 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. [optional]
variable_category_id int Ex: 1 [optional]
variable_category_image_url string Ex: https://maxcdn.icons8.com/Color/PNG/96/Cinema/theatre_mask-96.png [optional]
variable_category_name string Ex: Emotions, Treatments, Symptoms... [optional]
variable_id int Id for the variable to be tracked [optional]
variable_image_url string Ex: https://image.png [optional]
variable_name string Name of the variable to be used when sending measurements [optional]

[Back to Model list] [Back to API list] [Back to README]