Get DashboardLayout

Version 4.0.26.2 (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
can
object
Operations the current user is able to perform on this object
id
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
boolean
Whether or not the dashboard layout is deleted.
dashboard_title
string
Title extracted from the dashboard this layout represents.
dashboard_layout_components
Expand DashboardLayoutComponent definition...
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
granular_row
integer
Row (granular layout)
granular_column
integer
Column (granular layout)
granular_width
integer
Width (granular layout)
granular_height
integer
Height (granular layout)
label
string
Label
description
string
Description
order
integer
Order

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

429: Too Many Requests

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

Examples

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-09 UTC.