Version 4.0.24.18 (latest)
Update the dashboard layout with a specific id.
Request
PATCH
/dashboard_layouts/{dashboard_layout_id}
Datatype
Description
Request
path
Expand HTTP Path definition...
dashboard_layout_id
Id of dashboard layout
body
Expand HTTP Body definition...
body
DashboardLayout
Expand DashboardLayout definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
dashboard_id
Id of Dashboard
type
Type
active
Is Active
column_width
Column Width
width
Width
deleted
lock
Whether or not the dashboard layout is deleted.
dashboard_title
lock
Title extracted from the dashboard this layout represents.
dashboard_layout_components
query
Expand HTTP Query definition...
fields
Requested fields.
Response
200: DashboardLayout
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
dashboard_id
Id of Dashboard
type
Type
active
Is Active
column_width
Column Width
width
Width
deleted
lock
Whether or not the dashboard layout is deleted.
dashboard_title
lock
Title extracted from the dashboard this layout represents.
dashboard_layout_components
Expand DashboardLayoutComponent definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
dashboard_layout_id
Id of Dashboard Layout
dashboard_element_id
Id Of Dashboard Element
row
Row
column
Column
width
Width
height
Height
deleted
lock
Whether or not the dashboard layout component is deleted
element_title
lock
Dashboard element title, extracted from the Dashboard Element.
element_title_hidden
lock
Whether or not the dashboard element title is displayed.
vis_type
lock
Visualization type, extracted from a query's vis_config
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link