Dashly

Records one entry on a topic and reports today's total. Convert the value into the topic's unit first. Use occurredAt for something that happened earlier. Call list_topics first if you do not have the topic id.

log_entry

Records up to 50 entries in one call, for example every food in a meal or a backlog. All or nothing: if one entry is invalid, none are written and the error says which. Use it whenever there are several entries.

log_entries

Moves every entry from the source topic into the target and archives the source. Both must have the same type and unit; convert first with update_topic and unitFactor if the units differ. Ask the person first.

merge_topics

Pauses every topic over a range of days: a holiday, an illness. Paused days count like skipped ones. A pause can start up to 7 days back or up to 60 days ahead, and lasts up to 30 days.

pause_days

Lists a topic's entries, newest first, 50 per page by default. Pass the previous nextCursor to get the next page. For questions like "how was my week" use summarize_topic instead; use this to find a specific entry or read notes.

query_entries

Changes the companion that shows the person's day on the status tile, the calendar and when they log: Pip the penguin, Bao the capybara, Lumi the axolotl, or a person that looks like them. Pass a name alone to rename it (only when the person asks). For a person, look at a photo they share and fill the spec from the fixed lists; the photo itself never goes to Dashly, and the drawing is a friendly likeness, not a portrait. A new animal without a name gets its own (Pip, Bao, Lumi).

set_companion

Takes one day off one topic with a goal, when the person says so ("skip stretching today, my back hurts"). A skipped day does not count against the goal and does not break the streak. Up to 7 days back; not for tasks (move their due date instead). For time off across everything, use pause_days.

skip_day

How a day went across everything the person tracks: each topic's state (met, under, over, not logged, skipped), the day score ("5 of 7 on track") and any skips or pauses. Every daily goal counts on its own: a field with a daily goal (protein on Food) is its own row, with `field` set and a name like "Food · Protein", so Food can be on track for calories and behind on protein. Use it for "how was my day" or "how am I doing today". Weekly, monthly and dated goals show their progress but stay out of the day score.

summarize_day

Totals, today, daily average, streak, best day and goal progress for a topic over a range. Use it for "how was my week"; query_entries returns the individual entries. Streak and best are counted within the range, so pass 90d or all to find a long streak.

summarize_topic

Removes a skip or a pause by its id (from skip_day, pause_days or summarize_day). Ask the person first.

unskip

Changes a dashboard's title or document. The document is a patch, not a replacement: upsert or remove cards by id and move cards to a new position, and everything you do not mention stays. A dashboard document is one wall of cards in order; each card shows one topic (or a page-level widget) with 1 to 4 widgets. size is auto (the default, chosen from the widgets), sm, md, wide or lg; style can override the card color and icon (a name from tiles.icons); the scene a topic plays in its tile is the visual of the topic, set with update_topic; theme.density compact sets the tiles closer together. Which widgets each type allows and what each card size draws are in get_capabilities (tiles.draws). A patch that is wrong is rejected whole, and the error names the path and the allowed values. Widgets are optional when you upsert a card that names a topic: it gets that topic's default widgets. Leave size at auto and style alone unless the person asks for something specific. Keep a dashboard to the few topics that belong together, at most 8 cards; put other themes on their own dashboard. On home the status card always stays first; topic cards come and go there as on any dashboard. When the person wants a topic off home, remove its card here; never archive the topic for that.

update_dashboard

Changes a topic. Only the fields you send change; fields, statuses and goal replace the whole previous value. To change the unit and keep history correct, send the new unit with unitFactor, which multiplies every stored value and the goal (litres to millilitres: 1000). Ask the person before changing a unit.

update_topic

Changes the account timezone, which decides what "today" means for every total and streak. Use an IANA name; an invalid one is rejected with examples.

update_account

Corrects an entry. Only the fields you send change; `values` merges into the existing values. Ask the person before changing something they did not mention.

update_entry