Data Freshness fields and settings

Every field well and every setting in the format pane of version 1.0.0.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 Data Freshness page; every setting works in edit mode with or without one.

9 fields · 12 cards · 75 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Refreshed At`refreshed`	Measure	Optional	When the data was last refreshed. Recipe: a one-row Power Query table with DateTimeZone.RemoveZone(DateTimeZone.UtcNow()), then MAX of it. Read as UTC by default (Time Zones card).
Data Through`through`	Measure	Optional	The last date the data covers, e.g. CALCULATE(MAX(Sales[Order Date]), REMOVEFILTERS()). Tested against the expected lag.
Source`source`	Column	Optional	Optional: one row per source or table (a load log, dataflows). Shows a list with a state per source.
Source Detail`detail`	Column	Optional	Optional text under each source name: owner, system, schedule.
Last Status`status`	Measure	Optional	Optional: the outcome of the last refresh run, as text (Succeeded, Failed, Cancelled) or a numeric code (Last Status card). Shown next to the refresh time; a failed run marks the source stale by default.
Next Refresh`next`	Measure	Optional	Optional: the next scheduled refresh, when your data knows it. Wins over the Refresh Schedule card.
Ageing After (Hours)`ageingAfter`	Measure	Optional	Optional per-source threshold from your data; wins over the format pane.
Stale After (Hours)`staleAfter`	Measure	Optional	Optional per-source threshold from your data; wins over the format pane.
Tooltips`tooltips`	Measure	Optional · up to 5	Extra measures shown in the tooltip.

Theme`theme`

Setting	Type and options
Theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean `clean` Slate `slate`
Transparent Background`transparentBg`	On / off

Layout`layout`

Setting	Type and options
Layout`layout`	Auto (fit the space) `auto` Badge `badge` Header strip `strip` Corner chip `chip` Status card `card` Source list `list`
Alignment`align`	Auto `auto` Left `left` Center `center` Right `right`
Chip Position`chipCorner`	Top right `topRight` Top left `topLeft` Bottom right `bottomRight` Bottom left `bottomLeft` Center `center`
Source Order`order`	Worst first `worst` As in the data `data`
Shape`shape`	From the theme `theme` Pill `pill` Rounded `rounded` Square `square`
Font`font`	From the theme (Inter / Segoe UI) `theme` Segoe UI `segoe` Arial `arial` Georgia `georgia` Monospace `mono`
Text Size (px, 0 = Fit)`textSize`	Number
Headline Size (%)`headlineSize`	Number
Secondary Text Size (%)`secondarySize`	Number

Show`content`

Setting	Type and options
State Icon`icon`	On / off
State Word`stateWord`	On / off
Relative Age (2 hours ago)`relative`	On / off
Refresh Time (today 06:04)`absolute`	On / off
Last Status (Succeeded / Failed)`status`	On / off
Time Zone Name (CEST)`zoneName`	On / off
Data Through`through`	On / off
Next Refresh`next`	On / off
Reason When Not Fresh`reason`	On / off
Summary Line (Source List)`summary`	On / off
Column Headers (Source List)`headers`	On / off
Age Bar (Status Card)`ageBar`	On / off
UTC Time (Status Card)`utcRow`	On / off
Business-Time Age (Status Card)`businessAge`	On / off
As-Of Stamp`asOf`	In exports and snapshots `auto` Always `always` Never `never`

Time Zones`time`

Setting	Type and options
Refresh Time Is Stored As`storedAs`	UTC (recommended recipe) `utc` The viewer's time zone `viewer` A time zone or offset (type below) `zone`
Stored Time Zone`storedZone`	Text
Show Times In`displayZone`	The viewer's own time zone `viewer` UTC `utc` The business time zone `business`
Business Time Zone`businessZone`	Text
Clock`clock`	From the report language `auto` 24-hour (18:30) `24` 12-hour (6:30 PM) `12`
Relative Wording`relStyle`	Long (2 hours ago) `long` Short (2 hr. ago) `short` Narrow (2h ago) `narrow`
Keep Ageing While Open`live`	On / off

Refresh Age`staleness`

Setting	Type and options
Ageing After (Hours, 0 = Off)`ageingHours`	Number
Stale After (Hours, 0 = Off)`staleHours`	Number
Count Age In`countIn`	Business time (working days and hours) `business` Calendar time `calendar`

Data Coverage`coverage`

Setting	Type and options
Expected Lag (Days)`expectedLag`	Number
Ageing When Behind By (Days, 0 = Off)`ageingDays`	Number
Stale When Behind By (Days, 0 = Off)`staleDays`	Number
Count Missing Days In`countIn`	Working days `business` Calendar days `calendar`
Date Format`dateStyle`	Auto (yesterday, Fri 26 Sep) `auto` Short (26/09/2026) `short` Medium (26 Sep 2026) `medium` Long (26 September 2026) `long` ISO (2026-09-26) `iso`
Label`label`	Data through `words` The measure's name (Sales through) `field`

Refresh Schedule`schedule`

Setting	Type and options
Scheduled Times (06:00, 12:30)`times`	Text
Runs On`days`	Working days `workdays` Every day `every`
Late After (Minutes)`graceMinutes`	Number
Show Next Refresh As Approximate (~)`approx`	On / off

Last Status`lastStatus`

Setting	Type and options
Numeric Status Codes`codes`	0 = succeeded, other = failed (exit codes) `exit` SQL Agent (1 succeeded, 0 failed, 4 running) `sqlAgent` HTTP (2xx succeeded, 4xx/5xx failed) `http`
A Failed Last Run Makes the Source`onFailure`	Stale `stale` Ageing `ageing` No change (show the status only) `none`

Business Calendar`calendar`

Setting	Type and options
Weekend`weekend`	Saturday and Sunday `satSun` Friday and Saturday `friSat` Sunday only `sun` No weekend `none`
Working Hours (08:00-18:00, Empty = Whole Day)`hours`	Text
Holidays (YYYY-MM-DD, Comma Separated)`holidays`	Text

Text`wording`

Setting	Type and options
Refreshed Label`refreshed`	Text
Data Through Label`through`	Text
Next Refresh Label`next`	Text
Last Status Label`status`	Text
Source Column Label`source`	Text
State Column Label`stateCol`	Text
Your Time Label`yourTime`	Text
Fresh Word`fresh`	Text
Ageing Word`ageing`	Text
Stale Word`stale`	Text
Unknown Word`unknown`	Text

Colors`colors`

Setting	Type and options
Background`background`	Colour
Badge / Card Fill`surface`	Colour
Border`border`	Colour
Text`text`	Colour
Secondary Text`muted`	Colour
Accent and Rules`accent`	Colour
Fresh`fresh`	Colour
Ageing`ageing`	Colour
Stale`stale`	Colour
Unknown`unknown`	Colour

Sources`sources`

Setting	Type and options
Display Name`label`	Text
Ageing After (Hours, 0 = Default)`ageingHours`	Number
Stale After (Hours, 0 = Default)`staleHours`	Number

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": "dataFreshness4BAAAB2339CF41DABFC1E0BFB560FA50",
  "objects": {
    "theme": [{
      "properties": {
        "transparentBg": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Data Freshness fields and settings

Fields

Themetheme

Layoutlayout

Showcontent

Time Zonestime

Refresh Agestaleness

Data Coveragecoverage

Refresh Scheduleschedule

Last StatuslastStatus

Business Calendarcalendar

Textwording

Colorscolors

Sourcessources