Toggle menu

History API

log()

Write a new history or add an event to an existing history.

bucketHistories()

Define "buckets" of histories, count the histories in them, and run a "stopwatch" to count the time between created, last updated or a particular event.

countHistories()

Count histories matching a filter, combination of filters, or date range.

deleteHistories()

Delete histories that match a filter.

deleteHistory()

Delete a single history by ID or label.

getEventKeys()

Select histories using a filter and return all of their event key names.

getEventValues()

Select histories using a filter and return an array of values from events that match a key.

getHistories()

Return histories that match a filter. Optionally return their events.

getHistory()

Return a single history by ID or label. Filter the events that are returned.

getLabelValues()

Retrieve a label value from all histories that match a filter.

getSubjectKeys()

Select histories using a filter and return all of their subject key names.

getSubjectValues()

Select histories using a filter and return an array of values from subjects that match a key.

hideEvent()

Hides an event in a history. Hidden events are not returned by getHistory or getHistories unless in audit mode.

purgeHistories()

Registers a request to permanently delete histories that match a filter and have not been updated since a given time.

replaceEvent()

Replaces an existing event with new event data.

unhideEvent()

Restores a hidden event to its previous position.