Dashboard Widget - ClarusWMS

Dashboard widget attributes. A widget is a chart component bound to a report query; widget_type selects the chart rendering and configuration carries per-chart options. See the create endpoint's x-mint block for the per-type configuration keys.

code

string

required

Unique widget code

Maximum string length: 30

name

string

required

Display name

Maximum string length: 50

Chart rendering type. grid renders as a tabular data view rather than a chart.

Available options:

area,

bar,

funnel,

gauge,

graph,

grid,

heatmap,

line,

pictorial_bar,

pie,

radar,

sankey,

scatter,

single,

sunburst,

tree,

treemap

configuration

object

Chart rendering options. Shape varies by widget_type — common keys: metric, color_palette, show_legend, legend_position, limit. See the create endpoint's x-mint reference for per-type keys.

Example:

{
  "metric": "total_records",
  "color_palette": "default",
  "show_legend": true,
  "legend_position": "bottom",
  "horizontal": false,
  "log_scale": false,
  "limit": 10
}

dashboard_filters

object

Default filter values applied to the linked report query when the widget renders, e.g. { "warehouse_id": 1 }

Example:

{ "warehouse_id": 1 }

description

string | null

Optional widget description

Maximum string length: 255

report_query_id

integer | null

Linked report query that supplies the data. Optional — a widget may be standalone.