API and agentsAPI reference
MapWidget
object
One dashboard card: a formula (headline aggregate), category (top 5 + Other ranking; clicking a row EXCLUDES it), histogram (distribution with a brushable range), or note (authored title + body, no data). Data types are computed server-side over their layer's effective query. field is the aggregated/grouping/binned field (null for a count formula and for notes); agg is count | sum | avg | min | max (category ranking allows count | sum | avg; histogram and note ignore it — send count); aggField is the field a category sum/avg ranks by (null otherwise); unit/note/format are formula presentation (note doubles as a note widget's body); layerId is null exactly for notes.
idstringrequiredUnique within the map.
typestringrequiredOne of
formula,category,histogram,notelayerIdstringor nullrequiredThe layer the widget reads — and the only layer its selection filters. Null for notes.
titlestringrequiredCard heading (≤ 60).
fieldstringor nullrequiredaggstringrequiredOne of
count,sum,avg,min,maxaggFieldstringor nullrequiredunitstringor nullrequiredFormula: text after the number (≤ 20).
notestringor nullrequiredFormula: caption under the number; note widget: the body (≤ 2000).
formatstringor nullrequiredFormula number formatting; null = automatic.
One of
compact,percent,percent2,integer,decimal1,decimal2,nullvisiblebooleanrequired
7439201b