analytics
engine-dmo analytics: Rollups, recompute, retention and member reports. Every subcommand, argument and flag.
Rollups, recompute, retention and member reports.
| Command | What it does |
|---|---|
engine-dmo analytics collection | Report the events a site received by collection path (rendered, beacon, api) over the last days, and a headless site’s collection health |
engine-dmo analytics digest | Queue the member report digest for the current period |
engine-dmo analytics export | Export a dashboard or one metric over a range as CSV or JSON, as the Insight screen’s export does; audited |
engine-dmo analytics partitions | List the monthly raw partitions, create them ahead, and drop expired ones with --drop-expired |
engine-dmo analytics prune | Apply retention: raw partitions past raw_retention_days, hourly rollups and search log rows past theirs |
engine-dmo analytics recompute | Rebuild every rollup level from raw events for a range, idempotently, under the rules in force |
engine-dmo analytics report | One member’s report, as text or as a PDF |
engine-dmo analytics report-run | Queue an organisation report from analytics/reports.yaml for its current period |
engine-dmo analytics rollup | Roll raw events up into the hourly, daily and monthly tables for a range |
engine-dmo analytics collection
Report the events a site received by collection path (rendered, beacon, api) over the last days, and a headless site’s collection health.
engine-dmo analytics collection [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--days | int | 7 | how many days back, 1 to 90 |
--site | string | site key (default: the default site) |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo analytics digest
Queue the member report digest for the current period.
engine-dmo analytics digest [flags] Available in engine-dmo only.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--run | bool | work through the mail queue here rather than leaving it to the server |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo analytics export
Export a dashboard or one metric over a range as CSV or JSON, as the Insight screen’s export does; audited.
engine-dmo analytics export [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--as | string | export as this staff account (email), which needs analytics.export on the site | |
--compare | string | previous_year | previous_period | none (default: the dashboard’s) | |
--dashboard | string | a dashboard from analytics/dashboards.yaml; default is the overview | |
--format | string | csv | csv | json |
--from | string | the first day of a custom range, YYYY-MM-DD, in the site’s zone | |
--metric | string | one metric of the catalogue, as a single tile | |
--out | string | file to write; standard output when empty or - | |
--range | string | a range preset: today, 7d, 30d, 90d, 12m, this_month, previous_month, this_quarter, previous_quarter, this_financial_year, previous_financial_year, previous_year (default: the dashboard’s) | |
--site | string | site key (default: the default site) | |
--to | string | the last day of a custom range, inclusive |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo analytics partitions
List the monthly raw partitions, create them ahead, and drop expired ones with --drop-expired.
engine-dmo analytics partitions [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--drop-expired | bool | also apply retention, as engine-dmo analytics prune does |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo analytics prune
Apply retention: raw partitions past raw_retention_days, hourly rollups and search log rows past theirs.
engine-dmo analytics prune [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--dry-run | bool | report what would go and change nothing |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo analytics recompute
Rebuild every rollup level from raw events for a range, idempotently, under the rules in force.
engine-dmo analytics recompute [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--from | string | first day, YYYY-MM-DD | |
--to | string | last day, inclusive, YYYY-MM-DD (default today) |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo analytics report
One member’s report, as text or as a PDF.
engine-dmo analytics report [flags] Available in engine-dmo only.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--format | string | text | text, html or pdf |
--from | string | start date, such as 2026-01-01 (default: a year ago) | |
--organisation | string | the organisation’s id | |
--out | string | where to write; empty prints text and HTML to the terminal and writes a PDF to report.pdf, and - writes any format to standard output | |
--site | string | site key (default: the default site) | |
--to | string | end date (default: today) |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo analytics report-run
Queue an organisation report from analytics/reports.yaml for its current period.
engine-dmo analytics report-run [flags] Available in engine-dmo only.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--report | string | the report’s key in analytics/reports.yaml | |
--run | bool | work through the mail queue here rather than leaving it to the server | |
--site | string | the site; the default site when empty |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo analytics rollup
Roll raw events up into the hourly, daily and monthly tables for a range.
engine-dmo analytics rollup [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--from | string | first day, YYYY-MM-DD | |
--to | string | last day, inclusive, YYYY-MM-DD (default today) |
--json prints the text output in the JSON envelope. Runs in a project.