You are here:

Home

/

Documentation

/

Modules

/

Social density

Social density module

Table of contents

The social density module endpoint lets you log how crowded things felt on a specific day.

The endpoint returns the updated journal entry.

Log social density

This endpoint logs your social density for a journal entry.

URL parameters

id integer required

The ID of the journal.

year integer required

The year of the journal entry.

month integer required

The month of the journal entry.

day integer required

The day of the journal entry.

Query parameters

social_density string required

How crowded the day felt. Accepted values are: alone, few people, crowd, too much.

Response attributes

type string

The type of the resource.

id string

The ID of the journal entry.

attributes object

The attributes of the journal entry.

attributes.journal_id integer

The ID of the journal.

attributes.day integer

The day of the journal entry.

attributes.month integer

The month of the journal entry.

attributes.year integer

The year of the journal entry.

attributes.notes string

The rich text notes for the journal entry, rendered as HTML.

attributes.modules object

The modules included with the journal entry.

attributes.modules.sleep object

The sleep module payload.

attributes.modules.sleep.bedtime string

The bedtime time of the journal entry.

attributes.modules.sleep.wake_up_time string

The wake up time of the journal entry.

attributes.modules.sleep.sleep_duration_in_minutes integer

The sleep duration in minutes.

attributes.modules.work object

The work module payload.

attributes.modules.work.worked string

Whether you worked on the journal entry.

attributes.modules.work.work_mode string

The work mode for the journal entry.

attributes.modules.travel object

The travel module payload.

attributes.modules.travel.has_traveled_today string

Whether you traveled today.

attributes.modules.travel.travel_mode array

The travel modes used for the journal entry.

attributes.modules.weather object

The weather module payload.

attributes.modules.weather.condition string

The weather condition.

attributes.modules.weather.temperature_range string

The temperature range for the day.

attributes.modules.weather.precipitation string

The precipitation level.

attributes.modules.weather.daylight string

The daylight length.

attributes.modules.weather_influence object

The weather influence module payload.

attributes.modules.weather_influence.mood_effect string

How the weather affected your mood.

attributes.modules.weather_influence.energy_effect string

How the weather affected your energy.

attributes.modules.weather_influence.plans_influence string

How the weather influenced your plans.

attributes.modules.weather_influence.outside_time string

How much time you spent outside.

attributes.modules.shopping object

The shopping module payload.

attributes.modules.shopping.has_shopped_today string

Whether you shopped today.

attributes.modules.shopping.shopping_type array

The shopping types for the journal entry.

attributes.modules.shopping.shopping_intent string

The intent behind the shopping.

attributes.modules.shopping.shopping_context string

The shopping context for the entry.

attributes.modules.shopping.shopping_for string

Who the shopping was for.

attributes.modules.meals object

The meals module payload.

attributes.modules.meals.meal_presence array

The meals you had. Possible values: breakfast, lunch, dinner, snack.

attributes.modules.meals.meal_type string

The meal type. Accepted values are: home_cooked, takeout, restaurant, work_cafeteria.

attributes.modules.meals.social_context string

Who you ate with. Accepted values are: alone, family, friends, colleagues.

attributes.modules.meals.has_notes string

Whether meal notes are enabled.

attributes.modules.meals.notes string

Optional notes about your meals.

attributes.modules.kids object

The kids module payload.

attributes.modules.kids.had_kids_today string

Whether you had the kids today.

attributes.modules.day_type object

The day type module payload.

attributes.modules.day_type.day_type string

The type of day.

attributes.modules.primary_obligation object

The primary obligation module payload.

attributes.modules.primary_obligation.primary_obligation string

What demanded most of your attention.

attributes.modules.health object

The health module payload.

attributes.modules.health.health string

How you felt on that day.

attributes.modules.hygiene object

The hygiene module payload.

attributes.modules.hygiene.showered string

Whether you showered.

attributes.modules.hygiene.brushed_teeth string

When you brushed your teeth.

attributes.modules.hygiene.skincare string

Whether you did skincare.

attributes.modules.mood object

The mood module payload.

attributes.modules.mood.mood string

The mood for that day.

attributes.modules.reading object

The reading module payload.

attributes.modules.reading.did_read_today string

Whether you read today.

attributes.modules.reading.books array

The books you read on that day.

attributes.modules.reading.books.id integer

The ID of the book.

attributes.modules.reading.books.name string

The name of the book.

attributes.modules.reading.books.status string

The reading status for this journal entry.

attributes.modules.reading.reading_amount string

How much you read.

attributes.modules.reading.mental_state string

Your mental state after reading.

attributes.modules.reading.reading_feel string

How reading felt.

attributes.modules.reading.want_continue string

Whether you wanted to continue reading.

attributes.modules.reading.reading_limit string

What limited your reading.

attributes.modules.energy object

The energy module payload.

attributes.modules.energy.energy string

The energy level for that day.

attributes.modules.cognitive_load object

The cognitive load module payload.

attributes.modules.cognitive_load.cognitive_load string

The cognitive load for that day.

attributes.modules.cognitive_load.primary_source string

The primary source of the cognitive load.

attributes.modules.cognitive_load.load_quality string

The quality of the cognitive load.

attributes.modules.social_density object

The social density module payload.

attributes.modules.social_density.social_density string

How crowded the day felt.

attributes.modules.social_events object

The social events module payload.

attributes.modules.social_events.event_type string

The type of social event.

attributes.modules.social_events.tone string

The tone of the social event.

attributes.modules.social_events.duration string

The duration of the social event.

attributes.modules.physical_activity object

The physical activity module payload.

attributes.modules.physical_activity.has_done_physical_activity string

Whether physical activity was done.

attributes.modules.physical_activity.activity_type string

The type of physical activity.

attributes.modules.physical_activity.activity_intensity string

The intensity of the physical activity.

attributes.created_at integer

The date and time the object was created, in Unix timestamp format.

attributes.updated_at integer

The date and time the object was last updated, in Unix timestamp format.

links object

The links to access the journal entry.

PUT /api/journals/{id}/{year}/{month}/{day}/social-density
{
"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"
}
}
}