Get Dashboard

returns a specific dashboard item according to id
:return: DashboardItem

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns one dashboard item by its ID, including its query type, data source, data configuration, metadata, and the dashboard it belongs to.

When to use it

Use it to read a widget's configuration, for example before you change it with Update a dashboard item.

Required parameters

  • dashboard_item_id (path): the ID of the dashboard item.

Response

A successful call returns 200 OK with the DashboardItem object. Its required fields are id, name, query_type, datasource, data_config, created_by, created_at, updated_at, and dashboard_id.

Related: List dashboard items, Update a dashboard item, Delete a dashboard item

Path Params
uuid
required
Responses

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json