HTTP API: journal
The 1 operation tagged journal, each with its parameters, its body and what it answers.
What happened over a period, with what was said
GET /v1/journal
Return what happened, newest first, with who did it and what they said.
This is the change feed joined, not a second record of anything. Every entry is one event; what is added is what a comment said, the actor's name, and the meaning of the values inside a change - three things the feed leaves as an id or omits, and three things nobody can reconstruct from it.
No entry carries a whole text. A comment is its opening on one line, at most 140 characters
and ended at a word unless that would keep fewer than a third of them, with said_truncated
saying whether there is more; the item's comments have the rest. A change to a title, a
description or a body says that it changed and not what it said either side, which
/v1/changes still carries.
Ask for a period with ?created_at.gte=, in the same grammar every listing takes.
Without one you get the most recent entries, which is what somebody arriving with no
particular day in mind wants.
The latest entries, newest first, unlike the change feed. A feed is read forwards because
it resumes; a journal is a report about a past stretch of time, and the recent end is the one
somebody asking for it usually means - so the entries before these are the page after.
Pass oldest=true for a period's first entries in the order they happened, which is what
you want when writing it up.
Parameters
workspace_id(stringornull, in query): Narrow to one workspace, by id or slug. The default spans all of them.actor(stringornull, in query): 'me' for what this credential itself did, or a username for everything that account did through any of its credentials. Omit for everybody.oldest(boolean, in query): Read forwards from the start of the period rather than back from its end.limit(integerornull, in query): How many entries to return.format(stringornull, in query): 'full' (default), 'compact' for one aligned line per item, or 'ids' for the addresses alone. Compact is roughly a twentieth the size of full.fields(stringornull, in query): Comma-separated field names to return instead of the whole item, e.g. 'ref,title,due_at'. GET /v1/meta lists what each entity has. Cannot be combined with 'format'.
Responses
200:Journal. Successful Response422:HTTPValidationError. Validation Error