| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| api:api_journal [2019/11/27 12:37] – Lauri Elevant | api:api_journal [2020/10/14 13:32] – [Parameters] Lauri Elevant |
|---|
| | ''byEvents'' | Optional | List of journal events you are interested in | [1] | | | ''byEvents'' | Optional | List of journal events you are interested in | [1] | |
| | ''bySince'' | Optional | A date or the ID from which you want to start searching from | [2] | | | ''bySince'' | Optional | A date or the ID from which you want to start searching from | [2] | |
| | | ''order'' | Optional | Should the call return newest events first or oldest first. Legal values are "newest-first" and "oldest-first" (default). If an illegal value is provided, the default will be applied silently. | [3] | |
| | | ''limit'' | Optional | How many journal events to return (Allowed range is normally 1..1024, 1024 being the default). If the ''expand'' parameter is used, the limit is 256. If the limit is exceeded, it is silently capped. | [3] | |
| |
| * // Note [1]: See the list of journal events below. The list must be comma-separated. All list items are combined with logical ''OR'' operators - in other words a journal event is considered matching if it matches to any of the values provided in the list.// | * // Note [1]: See the list of journal events below. The list must be comma-separated. All list items are combined with logical ''OR'' operators - in other words a journal event is considered matching if it matches to any of the values provided in the list.// |
| * // Note [2]: An [[https://en.wikipedia.org/wiki/ISO_8601|ISO 8601 compatible date(time)]] // | * // Note [2]: An [[https://en.wikipedia.org/wiki/ISO_8601|ISO 8601 compatible date(time)]] // |
| | * // Note [3]: For backwards compatibility reasons, the default order/limit are set to "oldest-first" and 1024, respectively. In many cases, for example when polling for new events, it makes sense to fetch the last 10 items. In this case, set "order" to "newest-first" and "limit" to 10. // |
| |
| |