API Reference
- Getting Started
- Variables
- Measurements
- Analytics
- App Settings
- Data Import
- Feed
- Notifications
- Reminders
- Shares
- Studies
- Units
- User
Get client app settings
Get the settings for your application configurable at https://builder.quantimo.do
curl --request GET \
--url https://safe.dfda.earth/api/v3/appSettings{
"appSettings": {
"additionalSettings": {},
"appDescription": "<string>",
"appDesign": {},
"appDisplayName": "<string>",
"appStatus": {},
"appType": "<string>",
"buildEnabled": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"collaborators": [
{
"accessToken": "<string>",
"accessTokenExpires": "<string>",
"accessTokenExpiresAtMilliseconds": 123,
"administrator": true,
"avatar": "<string>",
"avatarImage": "<string>",
"capabilities": "<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>",
"clientUserId": "<string>",
"combineNotifications": true,
"createdAt": "<string>",
"description": "<string>",
"displayName": "<string>",
"earliestReminderTime": "<string>",
"email": "<string>",
"firstName": "<string>",
"getPreviewBuilds": true,
"hasAndroidApp": true,
"hasChromeExtension": true,
"hasIosApp": true,
"id": 123,
"lastActive": "<string>",
"lastFour": "<string>",
"lastName": "<string>",
"lastSmsTrackingReminderNotificationId": "<string>",
"latestReminderTime": "<string>",
"loginName": "<string>",
"password": "<string>",
"phoneNumber": "<string>",
"phoneVerificationCode": "<string>",
"primaryOutcomeVariableId": 123,
"primaryOutcomeVariableName": "<string>",
"pushNotificationsEnabled": true,
"refreshToken": "<string>",
"roles": "<string>",
"sendPredictorEmails": true,
"sendReminderNotificationEmails": true,
"shareAllData": true,
"smsNotificationsEnabled": true,
"stripeActive": true,
"stripeId": "<string>",
"stripePlan": "<string>",
"stripeSubscription": "<string>",
"subscriptionEndsAt": "<string>",
"subscriptionProvider": "<string>",
"timeZoneOffset": 123,
"trackLocation": true,
"updatedAt": "<string>",
"userRegistered": "<string>",
"userUrl": "<string>"
}
],
"createdAt": "<string>",
"userId": 123,
"users": [
{
"accessToken": "<string>",
"accessTokenExpires": "<string>",
"accessTokenExpiresAtMilliseconds": 123,
"administrator": true,
"avatar": "<string>",
"avatarImage": "<string>",
"capabilities": "<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>",
"clientUserId": "<string>",
"combineNotifications": true,
"createdAt": "<string>",
"description": "<string>",
"displayName": "<string>",
"earliestReminderTime": "<string>",
"email": "<string>",
"firstName": "<string>",
"getPreviewBuilds": true,
"hasAndroidApp": true,
"hasChromeExtension": true,
"hasIosApp": true,
"id": 123,
"lastActive": "<string>",
"lastFour": "<string>",
"lastName": "<string>",
"lastSmsTrackingReminderNotificationId": "<string>",
"latestReminderTime": "<string>",
"loginName": "<string>",
"password": "<string>",
"phoneNumber": "<string>",
"phoneVerificationCode": "<string>",
"primaryOutcomeVariableId": 123,
"primaryOutcomeVariableName": "<string>",
"pushNotificationsEnabled": true,
"refreshToken": "<string>",
"roles": "<string>",
"sendPredictorEmails": true,
"sendReminderNotificationEmails": true,
"shareAllData": true,
"smsNotificationsEnabled": true,
"stripeActive": true,
"stripeId": "<string>",
"stripePlan": "<string>",
"stripeSubscription": "<string>",
"subscriptionEndsAt": "<string>",
"subscriptionProvider": "<string>",
"timeZoneOffset": 123,
"trackLocation": true,
"updatedAt": "<string>",
"userRegistered": "<string>",
"userUrl": "<string>"
}
],
"redirectUri": "<string>",
"companyName": "<string>",
"homepageUrl": "<string>",
"iconUrl": "<string>",
"longDescription": "<string>",
"splashScreen": "<string>",
"textLogo": "<string>"
},
"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>"
}
}Query Parameters
Your client id can be obtained by creating an app at https://builder.quantimo.do
This is the secret for your obtained clientId. We use this to ensure that only your application uses the clientId. Obtain this by creating a free application at https://builder.quantimo.do.
Response
Can be used as body of help info popup
Can be used as title in help info popup
Get yours at https:://builder.quantimo.do
Get yours at https:://builder.quantimo.do
User access token
Is user administrator
User display name
User email
User id
User login name
Ex: 2018-08-08 02:41:19
Ex: 1533696079000
Ex: a:1:{s:13:"administrator";b:1;}
HTML element id
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Smaller square image
Smaller circular image
Ex: #f2f2f2
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Content
Ex: Title
HTML for the entire card.
Ex: <div>Content</div>
Larger image of variable dimensions
Ex: Title
check_box, date, email, number, postal_code, select_option, string, switch, text_area, unit, variable_category HTML element id
Selector list options
Ex: Title
Ex: Title
See https://html5pattern.com/ for examples
Ex: ion-refresh
A link to a web page or something. Not much more to say about that.
Key value pairs derived from user input fields, button clicks, or preset defaults
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingBody
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingTitle
Ex: subTitle
Ex: subTitle
Ex: Title
Ex: curedao
Ex: 118444693184829555362
Ex: 1
When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format
Your bio will be displayed on your published studies
Earliest time user should get notifications. Ex: 05:00:00
Ex: Mike
Ex: false
Ex: false
Ex: false
Ex: false
Ex: Date the user last logged in
Ex: 2009
Ex: Sinn
Ex: 1
Latest time user should get notifications. Ex: 23:00:00
Ex: PASSWORD
Ex: 618-391-0002
Ex: 1234
A good primary outcome variable is something that you want to improve and that changes inexplicably. For instance, if you have anxiety, back pain or arthritis which is worse on some days than others, these would be good candidates for primary outcome variables. Recording their severity and potential factors will help you identify hidden factors exacerbating or improving them.
A good primary outcome variable is something that you want to improve and that changes inexplicably. For instance, if you have anxiety, back pain or arthritis which is worse on some days than others, these would be good candidates for primary outcome variables. Recording their severity and potential factors will help you identify hidden factors exacerbating or improving them.
Ex: 1
Ex: ["admin"]
Ex: 1
Ex: 1
Share all studies, charts, and measurement data with all other users
Ex: false
Ex: 1
Ex: cus_A8CEmcvl8jwLhV
Ex: monthly7
Ex: sub_ANTx3nOE7nzjQf
UTC ISO 8601 YYYY-MM-DDThh:mm:ss
Ex: google
Ex: 300
Ex: 1
When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format
Ex: 2020-12-03 15:25:13 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
User id of the owner of the application
User access token
Is user administrator
User display name
User email
User id
User login name
Ex: 2018-08-08 02:41:19
Ex: 1533696079000
Ex: a:1:{s:13:"administrator";b:1;}
HTML element id
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Smaller square image
Smaller circular image
Ex: #f2f2f2
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Content
Ex: Title
HTML for the entire card.
Ex: <div>Content</div>
Larger image of variable dimensions
Ex: Title
check_box, date, email, number, postal_code, select_option, string, switch, text_area, unit, variable_category HTML element id
Selector list options
Ex: Title
Ex: Title
See https://html5pattern.com/ for examples
Ex: ion-refresh
A link to a web page or something. Not much more to say about that.
Key value pairs derived from user input fields, button clicks, or preset defaults
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingBody
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingTitle
Ex: subTitle
Ex: subTitle
Ex: Title
Ex: curedao
Ex: 118444693184829555362
Ex: 1
When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format
Your bio will be displayed on your published studies
Earliest time user should get notifications. Ex: 05:00:00
Ex: Mike
Ex: false
Ex: false
Ex: false
Ex: false
Ex: Date the user last logged in
Ex: 2009
Ex: Sinn
Ex: 1
Latest time user should get notifications. Ex: 23:00:00
Ex: PASSWORD
Ex: 618-391-0002
Ex: 1234
A good primary outcome variable is something that you want to improve and that changes inexplicably. For instance, if you have anxiety, back pain or arthritis which is worse on some days than others, these would be good candidates for primary outcome variables. Recording their severity and potential factors will help you identify hidden factors exacerbating or improving them.
A good primary outcome variable is something that you want to improve and that changes inexplicably. For instance, if you have anxiety, back pain or arthritis which is worse on some days than others, these would be good candidates for primary outcome variables. Recording their severity and potential factors will help you identify hidden factors exacerbating or improving them.
Ex: 1
Ex: ["admin"]
Ex: 1
Ex: 1
Share all studies, charts, and measurement data with all other users
Ex: false
Ex: 1
Ex: cus_A8CEmcvl8jwLhV
Ex: monthly7
Ex: sub_ANTx3nOE7nzjQf
UTC ISO 8601 YYYY-MM-DDThh:mm:ss
Ex: google
Ex: 300
Ex: 1
When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format
Ex: 2020-12-03 15:25:13 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
Array of error objects with message property
Error message
ex. OK or ERROR
true or false
Response code such as 200
A super neat url you might want to share with your users!
HTML element id
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Smaller square image
Smaller circular image
Ex: #f2f2f2
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Content
Ex: Title
HTML for the entire card.
Ex: <div>Content</div>
Larger image of variable dimensions
Ex: Title
check_box, date, email, number, postal_code, select_option, string, switch, text_area, unit, variable_category HTML element id
Selector list options
Ex: Title
Ex: Title
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
See https://html5pattern.com/ for examples
Ex: ion-refresh
A link to a web page or something. Not much more to say about that.
Key value pairs derived from user input fields, button clicks, or preset defaults
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingBody
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingTitle
Ex: subTitle
Ex: subTitle
Ex: Title
curl --request GET \
--url https://safe.dfda.earth/api/v3/appSettings{
"appSettings": {
"additionalSettings": {},
"appDescription": "<string>",
"appDesign": {},
"appDisplayName": "<string>",
"appStatus": {},
"appType": "<string>",
"buildEnabled": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"collaborators": [
{
"accessToken": "<string>",
"accessTokenExpires": "<string>",
"accessTokenExpiresAtMilliseconds": 123,
"administrator": true,
"avatar": "<string>",
"avatarImage": "<string>",
"capabilities": "<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>",
"clientUserId": "<string>",
"combineNotifications": true,
"createdAt": "<string>",
"description": "<string>",
"displayName": "<string>",
"earliestReminderTime": "<string>",
"email": "<string>",
"firstName": "<string>",
"getPreviewBuilds": true,
"hasAndroidApp": true,
"hasChromeExtension": true,
"hasIosApp": true,
"id": 123,
"lastActive": "<string>",
"lastFour": "<string>",
"lastName": "<string>",
"lastSmsTrackingReminderNotificationId": "<string>",
"latestReminderTime": "<string>",
"loginName": "<string>",
"password": "<string>",
"phoneNumber": "<string>",
"phoneVerificationCode": "<string>",
"primaryOutcomeVariableId": 123,
"primaryOutcomeVariableName": "<string>",
"pushNotificationsEnabled": true,
"refreshToken": "<string>",
"roles": "<string>",
"sendPredictorEmails": true,
"sendReminderNotificationEmails": true,
"shareAllData": true,
"smsNotificationsEnabled": true,
"stripeActive": true,
"stripeId": "<string>",
"stripePlan": "<string>",
"stripeSubscription": "<string>",
"subscriptionEndsAt": "<string>",
"subscriptionProvider": "<string>",
"timeZoneOffset": 123,
"trackLocation": true,
"updatedAt": "<string>",
"userRegistered": "<string>",
"userUrl": "<string>"
}
],
"createdAt": "<string>",
"userId": 123,
"users": [
{
"accessToken": "<string>",
"accessTokenExpires": "<string>",
"accessTokenExpiresAtMilliseconds": 123,
"administrator": true,
"avatar": "<string>",
"avatarImage": "<string>",
"capabilities": "<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>",
"clientUserId": "<string>",
"combineNotifications": true,
"createdAt": "<string>",
"description": "<string>",
"displayName": "<string>",
"earliestReminderTime": "<string>",
"email": "<string>",
"firstName": "<string>",
"getPreviewBuilds": true,
"hasAndroidApp": true,
"hasChromeExtension": true,
"hasIosApp": true,
"id": 123,
"lastActive": "<string>",
"lastFour": "<string>",
"lastName": "<string>",
"lastSmsTrackingReminderNotificationId": "<string>",
"latestReminderTime": "<string>",
"loginName": "<string>",
"password": "<string>",
"phoneNumber": "<string>",
"phoneVerificationCode": "<string>",
"primaryOutcomeVariableId": 123,
"primaryOutcomeVariableName": "<string>",
"pushNotificationsEnabled": true,
"refreshToken": "<string>",
"roles": "<string>",
"sendPredictorEmails": true,
"sendReminderNotificationEmails": true,
"shareAllData": true,
"smsNotificationsEnabled": true,
"stripeActive": true,
"stripeId": "<string>",
"stripePlan": "<string>",
"stripeSubscription": "<string>",
"subscriptionEndsAt": "<string>",
"subscriptionProvider": "<string>",
"timeZoneOffset": 123,
"trackLocation": true,
"updatedAt": "<string>",
"userRegistered": "<string>",
"userUrl": "<string>"
}
],
"redirectUri": "<string>",
"companyName": "<string>",
"homepageUrl": "<string>",
"iconUrl": "<string>",
"longDescription": "<string>",
"splashScreen": "<string>",
"textLogo": "<string>"
},
"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>"
}
}