Skip to main content
POST
Create widget

Authorizations

Authorization
string
header
required

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

Body

application/json
workspaceId
string<uuid>
required
chartType
enum<string>
required
Available options:
line,
area,
radar,
pie,
donut,
treemap,
stacked_bar,
stream
name
string
Maximum string length: 100
description
string | null
Maximum string length: 500
structuredDataId
integer | null
columnWidth
enum<string>
default:1/2
Available options:
1/4,
1/3,
1/2,
2/3,
3/4,
full
rowIndex
integer
default:0
Required range: x >= 0
sortOrder
integer
default:0
Required range: x >= 0
config
object

Response

Created widget

success
enum<boolean>
required
Available options:
true
data
object
required