Skip to main content
PATCH
Update a widget

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

project_id
string<uuid>
required
report_id
string<uuid>
required
page_id
string<uuid>
required
widget_id
string<uuid>
required

Body

application/json

Request body for updating an existing widget.

widget_type
string | null

Updated widget type.

data_source
string | null

Updated data source identifier.

title
string | null

Updated display title.

config
Config · object | null

Updated widget configuration (fully replaces existing config).

position_x
integer | null

Updated horizontal grid position.

position_y
integer | null

Updated vertical grid position.

width
integer | null

Updated widget width in grid columns.

height
integer | null

Updated widget height in grid rows.

Response

Successful Response

success
boolean
default:true
data
ReportWidgetResponse · object | null

A single report widget as returned by the API.