Skip to content

docs(search): document include_facets/include_histogram opt-in toggles #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
steveatlc wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(search): document include_facets/include_histogram opt-in toggles #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6519075
docs(search): document include_facets/include_histogram opt-in toggles
May 26, 2026
85b225c
docs(reference): fix broken asset-tags link in story-tags
May 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/4-data-queries/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Query and analyze your security telemetry using LimaCharlie Query Language (LCQL

### Run an LCQL Query

!!! info "Facets and histogram are opt-in"
The search API supports two optional boolean request body fields, `include_facets` and `include_histogram`. Both default to `false`: when they are omitted (or sent as `false`), the response is returned without facet aggregations and without the time-distribution histogram, and the matching response keys come back empty. Send `true` to request either block.

The web Query Console always opts in, so its facets sidebar and histogram render unchanged. This only affects callers using the REST API, the SDKs, or `lc-cli` directly.

=== "REST API"

```bash
Expand All @@ -33,7 +38,9 @@ Query and analyze your security telemetry using LimaCharlie Query Language (LCQL
"query": "event.FILE_PATH ends with .exe",
"startTime": "'"$START"'",
"endTime": "'"$END"'",
"stream": "event"
"stream": "event",
"include_facets": true,
"include_histogram": true
}'
```

Expand Down
2 changes: 1 addition & 1 deletion docs/8-reference/story-tags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Every segment that isn't a fixed keyword has a strict regex:
| `TARGET_NAME` | `^[a-z0-9][a-z0-9_.-]{0,127}$` | Same as `STORY_NAME` plus `.` (covers Hive record keys with dots). |
| `LABEL_SLUG` | `^[a-z0-9][a-z0-9_-]{0,63}$` | Same as `STORY_NAME`. Rendered with `-` and `_` turned into spaces. |

Tags that violate any gate are **silently dropped** by the assembler — they never produce phantom nodes or edges. This matches the [`lc:asset:*`](asset-tags.md) convention: malformed metadata must never show up in a dashboard.
Tags that violate any gate are **silently dropped** by the assembler — they never produce phantom nodes or edges. This matches the [`lc:asset:*`](../2-sensors-deployment/asset-tags.md) convention: malformed metadata must never show up in a dashboard.

### Canonical type slugs

Expand Down
Loading