Knowledge

Facet counts for the current selection

Counts of contacts, tags and calendar months, each answering "how many notes if I click this". Tags and contacts are multi-select AND, so their buckets run over the SAME selection the list returns, the facet's own selected values included; the period bar is single-select, so its buckets run over that selection with its period bound cleared -- otherwise a bucket would predict a query the click does not run. clearedTotals is the same question for each bar's All chip: the total with that one axis cleared. Selected tags and personIds are always present, even at count 0. Months are UTC YYYY-MM buckets, cut on note creation or on a linked event's date per periodBasis.

get/api/knowledge/facets

Request

  • Base URL: https://api.historis.app
  • URL: https://api.historis.app/api/knowledge/facets
  • Auth: HTTP bearer

Query parameters

querystring

Full-text query (French stemming, accent-insensitive).

status'active' | 'archived' | 'all'

Note status (default active).

tagsstring

Comma-separated tag slugs, max 20. AND: a note must carry every one.

personIdsstring

Comma-separated person ids, max 20. AND: a note must link to every one.

sincestring date-time

Notes created at or after this instant. Accepts YYYY-MM-DD or a full ISO 8601 instant with Z or a numeric offset; inclusive.

untilstring date-time

Notes created at or before this instant. Accepts YYYY-MM-DD or a full ISO 8601 instant with Z or a numeric offset; inclusive.

updatedSincestring date-time

Notes last modified at or after this instant. Accepts YYYY-MM-DD or a full ISO 8601 instant with Z or a numeric offset; inclusive.

updatedUntilstring date-time

Notes last modified at or before this instant. Accepts YYYY-MM-DD or a full ISO 8601 instant with Z or a numeric offset; inclusive.

eventSincestring date-time

Notes linked to an event that occurred at or after this instant (both event bounds apply to the same event). Accepts YYYY-MM-DD or a full ISO 8601 instant with Z or a numeric offset; inclusive.

eventUntilstring date-time

Notes linked to an event that occurred at or before this instant. Accepts YYYY-MM-DD or a full ISO 8601 instant with Z or a numeric offset; inclusive.

periodBasis'created' | 'event'

Which date the month buckets are cut on (default created).

Response

Facet counts

object required

Changes

No recorded changes to this operation across all 1 revision of this API.