Examples
Compare vs Franchisees
Compare vs Full Network
Compare vs Region Average
Attributes
string
required
Display name shown in the dropdown (e.g., “vs Franchisees”)
string
required
Aggregation function to apply across benchmark entities. Options: avg, median, min, max, sum, count, count_distinctAllowed values:
avgmedianminmaxsumcountcount_distinct
string
required
Column that defines individual entities (e.g., “store_id”, “customer_id”). Required for benchmark calculations.
string
Optional column or expression to use for benchmark calculation. If not specified, uses the main value column. Useful if you have a pre-aggregated benchmark table for RLS reasons.
string
SQL WHERE clause to filter which entities are included in the benchmark (e.g., “ownership_type = ‘franchise’”)
array
Dimension columns to group the benchmark by (e.g., [“region”]). Leave empty for dataset-wide benchmark.
boolean
default:"false"
Exclude the current row from its own benchmark calculation (table context only). Default: false
string
Default display type for this comparison. Options: pct (percentage change), abs (absolute change), compared_value (benchmark value)Allowed values:
pctabscompared_value
string
Custom comparison label text (overrides default “vs ”)
string
Format code for percentage values. See Value Formatting for available formats.
string
Format code for absolute values. See Value Formatting for available formats.
boolean
default:"false"
If true, negative changes are shown as positive (green)