Concepts
API documentation
Account management
Journals
Modules
Primary obligation module
Table of contents
The primary obligation module endpoint lets you log what demanded most of your attention today.
It captures priority, not time spent and not emotion.
The endpoint returns the updated journal entry.
Log primary obligation
This endpoint logs the primary obligation for a journal entry.
URL parameters
The ID of the journal.
The year of the journal entry.
The month of the journal entry.
The day of the journal entry.
Query parameters
The primary obligation. Accepted values are: work, family, personal, health, travel, none.
Response attributes
The type of the resource.
The ID of the journal entry.
The attributes of the journal entry.
The ID of the journal.
The day of the journal entry.
The month of the journal entry.
The year of the journal entry.
The rich text notes for the journal entry, rendered as HTML.
The modules included with the journal entry.
The sleep module payload.
The bedtime time of the journal entry.
The wake up time of the journal entry.
The sleep duration in minutes.
The work module payload.
Whether you worked on the journal entry.
The work mode for the journal entry.
The travel module payload.
Whether you traveled today.
The travel modes used for the journal entry.
The weather module payload.
The weather condition.
The temperature range for the day.
The precipitation level.
The daylight length.
The weather influence module payload.
How the weather affected your mood.
How the weather affected your energy.
How the weather influenced your plans.
How much time you spent outside.
The shopping module payload.
Whether you shopped today.
The shopping types for the journal entry.
The intent behind the shopping.
The shopping context for the entry.
Who the shopping was for.
The meals module payload.
The meals you had. Possible values: breakfast, lunch, dinner, snack.
The meal type. Accepted values are: home_cooked, takeout, restaurant, work_cafeteria.
Who you ate with. Accepted values are: alone, family, friends, colleagues.
Whether meal notes are enabled.
Optional notes about your meals.
The kids module payload.
Whether you had the kids today.
The day type module payload.
The type of day.
The primary obligation module payload.
What demanded most of your attention.
The health module payload.
How you felt on that day.
The hygiene module payload.
Whether you showered.
When you brushed your teeth.
Whether you did skincare.
The mood module payload.
The mood for that day.
The reading module payload.
Whether you read today.
The books you read on that day.
The ID of the book.
The name of the book.
The reading status for this journal entry.
How much you read.
Your mental state after reading.
How reading felt.
Whether you wanted to continue reading.
What limited your reading.
The energy module payload.
The energy level for that day.
The cognitive load module payload.
The cognitive load for that day.
The primary source of the cognitive load.
The quality of the cognitive load.
The social density module payload.
How crowded the day felt.
The social events module payload.
The type of social event.
The tone of the social event.
The duration of the social event.
The physical activity module payload.
Whether physical activity was done.
The type of physical activity.
The intensity of the physical activity.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
The links to access the journal entry.
{
"data": {
"type":
"journal_entry"
,
"id":
"442"
,
"attributes": {
"journal_id":
663
,
"day":
18
,
"month":
6
,
"year":
2024
,
"notes":
"<p>Notes for the day.</p>"
,
"modules": {
"sleep": {
"bedtime":
"22:30"
,
"wake_up_time":
"06:45"
,
"sleep_duration_in_minutes":
495
},
"work": {
"worked":
"yes"
,
"work_mode":
"remote"
},
"travel": {
"has_traveled_today":
"yes"
,
"travel_mode": [
"car"
,
"train"
]
},
"weather": {
"condition":
"sunny"
,
"temperature_range":
"warm"
,
"precipitation":
"none"
,
"daylight":
"normal"
},
"weather_influence": {
"mood_effect":
"positive"
,
"energy_effect":
"boosted"
,
"plans_influence":
"slight"
,
"outside_time":
"some"
},
"shopping": {
"has_shopped_today":
"yes"
,
"shopping_type": [
"groceries"
,
"online_shopping"
]
"shopping_intent":
"planned"
,
"shopping_context":
"with_partner"
,
"shopping_for":
"for_household"
},
"meals": {
"meal_presence": [
"breakfast"
,
"dinner"
]
"meal_type":
"home_cooked"
,
"social_context":
"family"
,
"has_notes":
"yes"
,
"notes":
"Cooked a new pasta recipe"
},
"kids": {
"had_kids_today":
"no"
},
"day_type": {
"day_type":
"workday"
},
"primary_obligation": {
"primary_obligation":
"work"
},
"health": {
"health":
"good"
},
"hygiene": {
"showered":
"yes"
,
"brushed_teeth":
"am"
,
"skincare":
"no"
},
"mood": {
"mood":
"great"
},
"reading": {
"did_read_today":
"yes"
,
"books": [ { "id":
12
, "name":
"Dune"
, "status":
"continued"
} ] ,
"reading_amount":
"one solid session"
,
"mental_state":
"stimulated"
,
"reading_feel":
"engaging"
,
"want_continue":
"strongly"
,
"reading_limit":
"time"
},
"energy": {
"energy":
"high"
},
"cognitive_load": {
"cognitive_load":
"high"
,
"primary_source":
"work"
,
"load_quality":
"productive"
},
"social_density": {
"social_density":
"few people"
},
"social_events": {
"event_type":
"friends"
,
"tone":
"positive"
,
"duration":
"medium"
},
"sexual_activity": {
"has_sexual_activity":
"yes"
,
"sexual_activity_type":
"with_partner"
},
"physical_activity": {
"has_done_physical_activity":
"yes"
,
"activity_type":
"running"
,
"activity_intensity":
"moderate"
}
},
"created_at":
1751305720
,
"updated_at":
1751305720
},
"links": {
"self":
"https://j.codingcat12.net/api/journals/663/2024/6/18"
}
}
}