Skip to content

List Endpoint

POST
/user/dashboard/list

List the metadata of all dashboards for the given

To get the full content of a dashboard, use the /get enpoint. The returned revision fields can be used to perform updates using the /store endpoint.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
ListDashboardRequest
object
tenant_id
required
Tenant Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

ListDashboardResponse
object
dashboards
required
Dashboards
Array<object>
DashboardRevisionSummary
object
metadata
required
DashboardRevisionMetadata
object
update_time
required
Update Time
string
revision
required
Revision
string
dashboard_id
required
Dashboard Id
string
summary
required
Summary
object
key
additional properties
any

403

Section titled “403 ”

{"detail": "Invalid API Key"}

404

Section titled “404 ”

{"detail": "Dashboard not found"}

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string