analytics/reports.yaml and dashboards.yaml
Every key of config/analytics/reports.yaml (scheduled member and organisation reports) and config/analytics/dashboards.yaml (organisation dashboards and manually entered figures).
config/analytics/reports.yaml declares scheduled member and organisation reports. config/analytics/dashboards.yaml declares the organisation dashboards and the figures staff enter per period.
engine-dmo analytics report-run queues a report for its current period, and engine-dmo analytics export exports a dashboard. Reports to members need engine-dmo. See Analytics.
analytics/reports.yaml
| Key | Type | Default | Meaning |
|---|---|---|---|
reports | list of objects | [] | Scheduled reports |
reports[].audience | member, organisation | Required | member (a report a member organisation receives) or organisation (a report about the destination’s own organisation) |
reports[].compare | none, previous_period, previous_year | none | none, previous_period or previous_year |
reports[].dashboard | string | The dashboard it is built from | |
reports[].format | any | The output format or formats | |
reports[].id | string | Written for you | The element’s stable id. Written by engine-dmo check --fix; never write or change it by hand |
reports[].key | string | Required | The report’s key |
reports[].metrics | list of objects | The figures it carries, each with key, kind, label and an optional target | |
reports[].metrics[].key | string | See reports[].metrics | |
reports[].metrics[].kind | string | See reports[].metrics | |
reports[].metrics[].label | map of string | See reports[].metrics | |
reports[].metrics[].target | number | See reports[].metrics | |
reports[].name | map of string | Its name per locale | |
reports[].range | previous_financial_year, previous_month, previous_quarter, previous_year, this_financial_year, this_month, this_quarter | The period it covers: this_month, previous_month, this_quarter, previous_quarter, previous_year, this_financial_year, previous_financial_year | |
reports[].schedule | string | When it runs, as a cron schedule | |
reports[].sites | list of string | Every site | The sites it covers |
reports[].tiers | any | Every tier | The membership tiers it goes to: a list of keys or { min: <tier> } |
reports[].to | string | Where an organisation report is sent |
analytics/dashboards.yaml
| Key | Type | Default | Meaning |
|---|---|---|---|
dashboards | list of objects | [] | Organisation dashboards on the Insight screen |
dashboards[].compare | string | The comparison it opens with | |
dashboards[].default_range | string | The range it opens on | |
dashboards[].key | string | Required | The dashboard’s key |
dashboards[].name | map of string | Its name per locale | |
dashboards[].widgets | list of objects | The tiles: each a type with its metric, dimension, breakdown, interval, limit, order, size, steps, label and highlight | |
metrics | list of objects | [] | Figures staff enter by hand per period, beside the measured ones |
metrics[].description | map of string | What it measures, per locale | |
metrics[].id | string | Written for you | The element’s stable id. Written by engine-dmo check --fix; never write or change it by hand |
metrics[].key | string | Required | The figure’s key |
metrics[].kind | string | Its kind | |
metrics[].label | map of string | Its name per locale | |
metrics[].period | string | How often it is entered | |
metrics[].unit | string | Its unit |
paidlistings.yaml
Every key of config/paidlistings.yaml (engine-dmo), the paid listings payment provider (Stripe or none) with its secrets, and each site's tier prices and how promotions are paid.
accessibility.yaml
Every key of config/accessibility.yaml, the known accessibility issues register the statement and conformance report read.