User definition
A user is either a trialist or an active customer who purchased a program with Fitmate coach.
This user is identified by it's email address.
Email adresses are unique per user on our system.
Our API expose various informations and dataset of a user.
There is 3 main categories of informations available on a user:
- user general informations
- body profile
- my goals (including tracking of progress)
User profile informations
| Field | Type | Description |
|---|---|---|
| First Name | String | The first name of the user. |
| Last Name | String | The last name of the user. |
| Email address | String | The email address of the user (unique ID). |
| Mobile Number | String | The mobile number of the user. |
| Date of birth | Date | The date of birth of the user. |
| Gender at birth | String | Gender |
| Height (ft and inches) | String | Height in ft and inches |
| Current weight (lbs) | Number | Current weight in lbs |
| Target weight (lbs) | Number | Target weight in lbs |
| Pregnant | Boolean | Is the user pregnant? |
Body profile
Body profile informations are often updated by the coach. We try to have informations up to date weekly. The level of precision of the body profile depends on the user's plan and willing to update the coach.
| Field | Type | Description |
|---|---|---|
| Body waist | Number | Current body waist |
| Measurment date | Date | date of measurement |
| Energy level | Number | Level of energy the customer have (scale from 1 to 5) |
| Heart Rate | Number | Current heart rate |
| Self feeling | Number | An evaluation of how the user feels this week |
| Weight | Number | Current weight |
All these details will come and accumulate for each user.
My Goals
Coach set weekly goals to achieve in order to reach the target weight. We have a collection of goals available for each individual user and each target contains user feedback.
| Field | Type | Description |
|---|---|---|
| Goal ID | String | the unique identifier for the given goal |
| assignement Time | Date | Date of the assignment for the goal |
| Category | String | Group of goals family/category |
| Days | Array | List of days the goal is targeted to happen |
| Day per Week | Number | Number of time this is tracked per week |
| Description | String | The goal to achieve |
| Goal | String | The goal definition |
| Status | String | Status of the goal |
| Title | String | Title of the goal |
| Tracking | Array | List of records made towards a goal |
Tracking
For goals, customer are reporting to their coach about their progress.
We actually add the progress included within each goal of a customer.
The structure of each progress is as follow:
| Field | Type | Description |
|---|---|---|
| Date | Date | Date of the progress |
| Progress | String | Progress made towards the goal |