Skip to main content
PATCH
Change a dashboard widget

Authorizations

Authorization
string
header
required

A workspace API key, created in Superlog under Settings → API keys.

Path Parameters

dashboardId
string<uuid>
required

Dashboard ID.

widgetId
string<uuid>
required

Widget ID.

Body

application/json
config
object

What the widget reads and how it shows it. source is logs or traces. filter.resourceAttrs keys may start with resource., span., log., or field.; a bare key is a resource attribute. aggregation defaults to count; other aggregations read field, which is duration or an attribute key. groupBy splits the result into series by an attribute key. display is timeseries, number, bar_list, or table. Metric widgets need metricName.

layout
object

Position on a 12-column grid: x 0 to 11, w 1 to 12, and y and h in rows. Charts are usually 6 wide and 4 high, tables 12 by 6, and text 4 by 5.

title
string
Required string length: 1 - 200

Response

OK

widget
object
required