Cohort Retention fields and settings

Every field well and every setting in the format pane of version 1.0.2.0, read from the package you download. The internal names in grey are what a PBIR file or a report-authoring agent uses. Which features need a licence is on the Cohort Retention page; every setting works in edit mode with or without one.

10 fields · 13 cards · 69 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Entity`entity`	Column	Optional	The thing that is retained — customer, employee, patient, account. One row per entity-event.
Event Date`eventDate`	Column	Optional	The date of each event. The visual derives the first-event date, the cohort and the period offset from this — no DAX and no period table needed.
Cohort Date (Optional)`cohortDate`	Column	Optional	A model-computed first-event date. Bind it when slicers filter the event table: the derived cohort would otherwise shift with the filter. When bound, it wins over the derived date.
Value`value`	Measure	Optional	Revenue, usage or hours per event. Enables value retention (NRR), ARPU and the LTV curve.
Segment`segment`	Column	Optional	Splits the board into compared segments. An entity belongs to the segment of its first event.
As Of Date`asOf`	Measure	Optional	Pins the observation date. Without it the visual uses the latest event date in the data.
Cohort (Pre-Aggregated)`cohortKey`	Column	Optional	Pre-aggregated mode: the cohort label, one row per cohort and period.
Period Index (Pre-Aggregated)`periodIndex`	Column	Optional	Pre-aggregated mode: the whole-number period offset (0, 1, 2 …).
Active Count (Pre-Aggregated)`activeCount`	Measure	Optional	Pre-aggregated mode: entities active in that cohort and period.
Base Count (Pre-Aggregated)`baseCount`	Measure	Optional	Pre-aggregated mode: the cohort's base. Without it the base is the row at period 0.

Cohorts`cohorts`

Setting	Type and options
Cohort & Period Grain`grain`	Day `day` Week `week` Month `month` Quarter `quarter` Year `year`
Week Starts On`weekStart`	Monday (ISO) `1` Sunday `0` Saturday `6`
Fiscal Year Starts In`fiscalYearStart`	January `1` February `2` March `3` April `4` May `5` June `6` July `7` August `8` September `9` October `10` November `11` December `12`
Newest Cohort on Top`sortNewestFirst`	On / off
Max Cohorts (0 = All)`maxCohorts`	Number

Periods`periods`

Setting	Type and options
Period Alignment`alignment`	Calendar `calendar` Anniversary (From First Event) `anniversary`
Period Direction`direction`	Left to Right `ltr` Right to Left `rtl`
Collapse Later Periods Into One Column`overflowBucket`	On / off
Max Periods (0 = All)`maxPeriods`	Number
First Period Is`firstPeriodLabel`	0 1
Show Only Periods (e.g. 0,1,7,14,30)`periodsShown`	Text

Metric`metric`

Setting	Type and options
Metric`metric`	Retention % `retentionPct` Active Entities `activeCount` Churn % `churnPct` Index to First Period (100) `indexToFirst` Value Retention % (Premium) `valueRetentionPct` Value per Active Entity (Premium) `valuePerActive` Cumulative Value per Entity — LTV (Premium) `cumulativeValuePerEntity`
Retention Definition`retention`	Classic (Active in Period) `classic` Rolling (Active in or After Period) `rolling` Sequential (Unbroken Chain) `sequential`
Denominator`denominator`	Cohort Base `cohortBase` Observed Base (Elapsed Windows Only) `observedBase` Previous Period `previousPeriod` Surviving Base (Renewal Chain) `survivingBase`
Active = Value at Least (0 = Any Event)`activeThreshold`	Number

Observation Window`window`

Setting	Type and options
Ignore Last N Periods (Data Lag)`ignoreLastPeriods`	Number
Unobservable Cells`unobservableStyle`	Diagonal Hatch `hatch` Dimmed Blank `dim` Hidden `hide`
Include Partial Periods in Averages`includePartialInAverages`	On / off

Low Base`lowBase`

Setting	Type and options
Minimum Base (0 = Off)`minBase`	Number
Show Base Count in Suppressed Cells`showBaseWhenSuppressed`	On / off

Views`views`

Setting	Type and options
Triangle`showTriangle`	On / off
Retention Curves`showCurves`	On / off
Layer Cake (Active by Cohort over Time)`showLayerCake`	On / off
Layout`layout`	Charts Below the Triangle `below` Charts Beside the Triangle `beside`
Density`density`	Comfortable `comfortable` Compact (More Rows per Tile) `compact`

Colors`colors`

Setting	Type and options
Color Scale Normalization`normalization`	Whole Board `global` Per Period Column `column` Per Cohort Row `row`
Low Color (empty = theme)`minColor`	Colour
High Color (empty = theme)`maxColor`	Colour
Reverse Scale`reverse`	On / off
Scale Midpoint (0 = Automatic)`midpoint`	Number
Color Legend`showLegend`	On / off
Discrete Steps (0 = Continuous)`discreteSteps`	Number
Below Benchmark (empty = theme)`belowColor`	Colour
Above Benchmark (empty = theme)`aboveColor`	Colour

Cells`cells`

Setting	Type and options
Show Values (Off = Heat Only)`showValues`	On / off
Decimals`decimals`	Number
Show Δ Under Each Value`deltaVsAverage`	On / off
Δ Measured Against`deltaTarget`	Period Average `average` Benchmark Curve `benchmark`
Font`fontFamily`	Inter `inter` Segoe UI `segoe` Arial `arial` Georgia `georgia`
Font Size`fontSize`	Number

Summaries`summaries`

Setting	Type and options
Cohort Size Column`showSizeColumn`	On / off
Size Column Bar`sizeBar`	On / off
Curve Sparkline per Cohort`showSparkline`	On / off
Period Average Row`showPeriodAverage`	On / off
Cohort Average Column`showCohortAverage`	On / off
Cohort Summary Column`rowStat`	None `none` Half-Life (Periods to Half) `halfLife` Retained Periods per Entity (Area) `auc`
Weight Averages by Base`weightedAverages`	On / off

Status Strip`statusStrip`

Setting	Type and options
Show Status Strip`show`	On / off
Static Mode (Export-Friendly)`staticExport`	On / off

Value & Cohort Comparison`analytics`

Setting	Type and options
Benchmark Curve (Premium)`benchmarkSource`	None `none` Best Cohort `best` Median Cohort `median` First Cohort `first` Typed Below `manual`
Benchmark Values (e.g. 100, 45, 38, 33)`benchmarkList`	Text
Color Cells by Variance vs Benchmark`benchmarkTint`	On / off
Age vs Calendar Panel (Premium)`showCalendarEffect`	On / off
Payback Target / CAC (0 = Off)`paybackTarget`	Number
Segment Comparison (Premium)`segmentLayout`	Side-by-Side Boards `boards` Difference Board (A − B) `difference`
Mark Significant Cohorts (Premium)`showSignificance`	On / off
Significance Level`alpha`	Number
Insights Strip (Premium)`showInsights`	On / off
Project Future Periods (Premium)`showProjection`	On / off
Project Up To Period`projectionHorizon`	Number

Text Sizes`text`

Setting	Type and options
Header Font Size (0 = Match Cells)`headerFontSize`	Number
Header Color (empty = theme)`headerColor`	Colour
Segment Title Font Size`boardTitleFontSize`	Number
Status Strip Font Size`statusFontSize`	Number
Insights Font Size`insightsFontSize`	Number
Chart Title Font Size`chartFontSize`	Number

Theme`theme`

Setting	Type and options
Theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean (White) `clean` Slate `slate`
Background Color (empty = theme)`bgColor`	Colour
Transparent Background`transparentBg`	On / off

Setting a value in PBIR

In a visual.json, a setting goes under visual.objects, by card and internal name. Toggles take true or false, choices and text a value in single quotes ('auto'), numbers a D suffix (12D).

"visual": {
  "visualType": "cohortRetention0311AB3EAC64A01680FA8115F2492694",
  "objects": {
    "cohorts": [{
      "properties": {
        "sortNewestFirst": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Cohort Retention fields and settings

Fields

Cohortscohorts

Periodsperiods

Metricmetric

Observation Windowwindow

Low BaselowBase

Viewsviews

Colorscolors

Cellscells

Summariessummaries

Status StripstatusStrip

Value & Cohort Comparisonanalytics

Text Sizestext

Themetheme