Get All DashboardLayoutComponents

Version 4.0.24.2 (latest)

Get information about all the dashboard layout components for a dashboard layout with a specific id.

Request

GET /dashboard_layouts/{dashboard_layout_id}/dashboard_layout_components
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
dashboard_layout_id
string
Id of dashboard layout component
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.

Response

200: DashboardLayoutComponent

Datatype
Description
can
object
Operations the current user is able to perform on this object
id
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
boolean
Whether or not the dashboard layout component is deleted
element_title
string
Dashboard element title, extracted from the Dashboard Element.
element_title_hidden
boolean
Whether or not the dashboard element title is displayed.
vis_type
string
Visualization type, extracted from a query's vis_config

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link