Skip to content

YAML Configuration

The WBR App is driven by a single YAML configuration file. It has five top-level sections, and they appear in this order:

setup:          # Required
data_sources:   # Optional (if uploading CSV directly)
annotations:    # Optional
metrics:        # Required
deck:           # Required
Section Purpose Required
setup Deck metadata: title, dates, fiscal year, display options Yes
data_sources Database connections, SQL queries, and CSV file references No (if uploading CSV directly)
annotations Business events overlaid on charts No
metrics Metric definitions: column mappings, filters, functions Yes
deck Visual blocks: charts, tables, sections, embeds Yes

Complete example

setup:
  week_ending: 25-SEP-2021
  week_number: 38
  title: Weekly Business Review
  fiscal_year_end_month: DEC
  tooltip: true
  db_config_url: https://example.com/connections.yaml

data_sources:
  MyProdPostgres:
    main_metrics:
      query: >
        SELECT date AS "Date", "Impressions", "Clicks"
        FROM wbr_sample_1;

annotations:
  - ./events.csv

metrics:
  Impressions:
    column: main_metrics.Impressions
    aggf: sum
  Clicks:
    column: main_metrics.Clicks
    aggf: sum
  ClickThruRate:
    function:
      divide:
        - metric:
            name: Clicks
        - metric:
            name: Impressions

deck:
  - block:
      ui_type: 6_12Graph
      title: Ad Impressions (Millions)
      y_scaling: "##.2MM"
      metrics:
        Impressions:
          line_style: primary
          graph_prior_year_flag: true

Sample config files

The repo includes two complete, working config files you can use as starting points:

These are the same files available via the admin UI's Get Reference Samples menu.

Getting started with YAML

If you have a CSV file and want to get started quickly, use the YAML auto-generator — upload your CSV and the app creates a starter YAML file with one 6_12Graph per column.