Version 4.0.25.20 (latest)
Get information about the dashboard layouts with a specific id.
Request
GET
/dashboard_layouts/{dashboard_layout_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
dashboard_layout_id
string
Id of dashboard layouts
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.
Response
200: DashboardLayout
Datatype
Description
(object)
can
lock
object
Operations the current user is able to perform on this object
id
lock
string
Unique Id
dashboard_id
string
Id of Dashboard
type
string
Type
active
boolean
Is Active
column_width
integer
Column Width
width
integer
Width
deleted
lock
boolean
Whether or not the dashboard layout is deleted.
dashboard_title
lock
string
Title extracted from the dashboard this layout represents.
dashboard_layout_components
Expand DashboardLayoutComponent definition...
can
lock
object
Operations the current user is able to perform on this object
id
lock
string
Unique Id
dashboard_layout_id
string
Id of Dashboard Layout
dashboard_element_id
string
Id Of Dashboard Element
row
integer
Row
column
integer
Column
width
integer
Width
height
integer
Height
deleted
lock
boolean
Whether or not the dashboard layout component is deleted
element_title
lock
string
Dashboard element title, extracted from the Dashboard Element.
element_title_hidden
lock
boolean
Whether or not the dashboard element title is displayed.
vis_type
lock
string
Visualization type, extracted from a query's vis_config
label
string
Label
description
string
Description
order
integer
Order
400: Bad Request
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
