Skip to main content
GET
The widgets on a board, including whether each one honours the board's site and period.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
dashboard_id
string
title
string
subtitle
string
widget_type
string
source_view
string
report_definition_id
string
filter_expression
string
measure_fn
string
measure_column
string
group_by
string
bucket
string
series_limit
string
sort
string
split_by
string
split_mode
string
split_limit
string
pivot_rows
string
pivot_column
string
pivot_measures
string
pivot_limit
string
show_subtotals
string
show_totals
string
site_column
string
period_column
string
unit
string
good_when
string
warn_threshold
string
bad_threshold
string
target_value
string
body
string
position
string
col_span
string
row_span
string
is_active
string
takes_site
string
takes_period
string
drill_route
string
drill_column
string
drill_split_column
string
drill_lens
string
drill_conditions
string
report_name
string
source_label
string
group_label
string
split_label
string
measure_label
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

bad_threshold
number<numeric>
body
string<text>
bucket
string<character varying>
Maximum string length: 10
col_span
integer<smallint>
dashboard_id
string<uuid>

Note: This is a Foreign Key to dashboards.id.

drill_column
string<text>
drill_conditions
string<jsonb>
drill_lens
string<text>
drill_route
string<character varying>
drill_split_column
string<text>
filter_expression
string<jsonb>
good_when
string<character varying>
Maximum string length: 10
group_by
string<character varying>
Maximum string length: 80
group_label
string<text>
id
string<uuid>

Note: This is a Primary Key.

is_active
boolean<boolean>
measure_column
string<character varying>
Maximum string length: 80
measure_fn
string<character varying>
Maximum string length: 10
measure_label
string<text>
period_column
string<character varying>
Maximum string length: 80
pivot_column
string<jsonb>
pivot_limit
integer<smallint>
pivot_measures
string<jsonb>
pivot_rows
string<jsonb>
position
integer<integer>
report_definition_id
string<uuid>

Note: This is a Foreign Key to report_definitions.id.

report_name
string<character varying>
Maximum string length: 150
row_span
integer<smallint>
series_limit
integer<smallint>
show_subtotals
boolean<boolean>
show_totals
boolean<boolean>
site_column
string<character varying>
Maximum string length: 80
sort
string<character varying>
Maximum string length: 20
source_label
string<text>
source_view
string<character varying>
Maximum string length: 80
split_by
string<character varying>
Maximum string length: 80
split_label
string<text>
split_limit
integer<smallint>
split_mode
string<character varying>
Maximum string length: 10
subtitle
string<character varying>
Maximum string length: 200
takes_period
boolean<boolean>
takes_site
boolean<boolean>
target_value
number<numeric>
title
string<character varying>
Maximum string length: 150
unit
string<character varying>
Maximum string length: 20
warn_threshold
number<numeric>
widget_type
string<character varying>
Maximum string length: 20