Skip to main content
PATCH

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

dashboard_id
string
required

Dashboard resource ID (22-character ShortUUID)

widget_id
string
required

Widget resource ID (22-character ShortUUID)

Body

application/json
display_name
string

Updated widget name

Required string length: 1 - 255
type
enum<string>

Type of widget.

  • chart: Visualization widget (line, bar, area, pie, histogram, statistic, top-list)
  • table: Tabular data widget with multiple metrics
  • text: Free-form text/markdown widget
Available options:
chart,
table,
text
Example:

"chart"

grid_x
integer | null

Grid column position

grid_y
integer | null

Grid row position

grid_w
integer | null

Grid column span

grid_h
integer | null

Grid row span

config
object

Widget configuration, structure depends on widget type

Response

Widget updated successfully

widget
object
required

Widget resource