Get Dashboard

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

Returns one dashboard by its ID, including its name, positions object, tags, and archive time.

When to use it

Use it to read a dashboard's details. To get its widgets, call List dashboard items with the dashboard's ID.

Required parameters

  • dashboard_id (path): the ID of the dashboard.

Response

A successful call returns 200 OK with the Dashboard object. Its required fields are id, name, created_by, created_at, updated_at, and positions.

Related: List dashboards, List dashboard items, Update a dashboard

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