Skip to main content
GET
Get a dashboard

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dashboardId
string<uuid>
required

Response

Successful response.

id
string<uuid>
required
name
string
required
Required string length: 1 - 120
layout
object
required
date_range
object
required

The one range every card runs over. A custom range spans at most 400 days.

filters
object[]
required

Applied to query reports whose metrics accept the dimension. Other cards run unfiltered.

Maximum array length: 10
created_via
enum<string>
required

dashboard means the Datalyr app.

Available options:
dashboard,
chat,
mcp,
api
created_at
string<date-time>
required
updated_at
string<date-time>
required
workspace_id
string<uuid>
cards
object[]

One entry per layout card. Present on get, create and update; not on list.

created_by
object
deleted_at
string<date-time> | null