Skip to content
Mako Docs

GET /{id}

GET
/api/workspaces/{workspaceId}/dashboards/{id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspaceId
required
string
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Dashboard details.

object
success
required
boolean
data
required
object
_id
string
Example
507f1f77bcf86cd799439011
workspaceId
string
Example
507f1f77bcf86cd799439011
title
required
string
description
string
dataSources
required
Array<object>
object
id
required
string
name
required
string
tableRef
required
string
query
required
object
connectionId
string
Example
507f1f77bcf86cd799439011
language
required
string
Allowed values: sql javascript mongodb
code
required
string
databaseId
string
databaseName
string
mongoOptions
object
collection
string
operation
string
Allowed values: find aggregate insertMany updateMany deleteMany findOne updateOne deleteOne
origin
object
type
required
string
Allowed values: saved_console local
consoleId
string
Example
507f1f77bcf86cd799439011
consoleName
string
importedAt
string format: date-time
timeDimension
string
rowLimit
number
computedColumns
Array<object>
object
name
required
string
expression
required
string
type
required
string
Allowed values: quantitative temporal nominal ordinal
cache
object
lastRefreshedAt
string format: date-time
rowCount
number
byteSize
number
parquetArtifactKey
string
definitionHash
string
artifactRevision
string
parquetVersion
string
parquetBuiltAt
string format: date-time
parquetBuildStatus
string | null
Allowed values: missing queued building ready error
parquetLastError
string
parquetUrl
string
relationships
required
Array<object>
object
id
required
string
from
required
object
dataSourceId
required
string
column
required
string
to
required
object
dataSourceId
required
string
column
required
string
type
required
string
Allowed values: one-to-one one-to-many many-to-one many-to-many
widgets
required
Array<object>
object
id
required
string
title
string
type
required
string
Allowed values: chart kpi table
dataSourceId
required
string
localSql
required
string
vegaLiteSpec
object
key
additional properties
kpiConfig
object
valueField
string
format
string
comparisonField
string
comparisonLabel
string
tableConfig
object
columns
Array<string>
pageSize
number
crossFilter
required
object
enabled
required
boolean
fields
Array<string>
layouts
required
object
lg
required
object
x
required
number
y
required
number
w
required
number
h
required
number
minW
number
minH
number
custom
boolean
md
object
x
required
number
y
required
number
w
required
number
h
required
number
minW
number
minH
number
custom
boolean
sm
object
x
required
number
y
required
number
w
required
number
h
required
number
minW
number
minH
number
custom
boolean
xs
object
x
required
number
y
required
number
w
required
number
h
required
number
minW
number
minH
number
custom
boolean
globalFilters
required
Array<object>
object
id
required
string
type
required
string
Allowed values: date-range select multi-select search
label
required
string
dataSourceId
required
string
column
required
string
config
required
object
key
additional properties
layout
required
object
order
required
number
width
number
crossFilter
required
object
enabled
required
boolean
resolution
required
string
Allowed values: intersect union
engine
string
Allowed values: mosaic legacy
materializationSchedule
required
object
enabled
required
boolean
cron
required
string | null
timezone
string
dataFreshnessTtlMs
number | null
layout
required
object
columns
required
number
rowHeight
required
number
cache
object
lastRefreshedAt
string format: date-time
snapshots
object
key
additional properties
object
version
required
string
generatedAt
string format: date-time
rowCount
required
number
rows
required
Array<object>
object
key
additional properties
fields
required
Array<object>
object
name
required
string
type
required
string
version
required
number
editLock
object
userId
required
string
userName
required
string
lockedAt
string format: date-time
expiresAt
string format: date-time
folderId
string
Example
507f1f77bcf86cd799439011
access
required
string
Allowed values: private workspace
workspaceRole
string
Allowed values: viewer editor
sharedWith
Array<object>
object
userId
required
string
role
required
string
Allowed values: viewer editor
addedAt
string format: date-time
publicShare
object
enabled
required
boolean
token
string
hasPassword
boolean
createdAt
string format: date-time
owner_id
string
createdBy
required
string
createdAt
string format: date-time
updatedAt
string format: date-time
readOnly
boolean

401

Section titled “401 ”

Authentication required

object
success
boolean
error
required
string
Example
Human-readable error message

403

Section titled “403 ”

Access denied

object
success
boolean
error
required
string
Example
Human-readable error message

404

Section titled “404 ”

Dashboard not found

object
success
boolean
error
required
string
Example
Human-readable error message

500

Section titled “500 ”

Internal server error

object
success
boolean
error
required
string
Example
Human-readable error message