Get dashboards

GET/api/v1/dashboards/{dashboardId}

Parameters

Path parameters
Field	Type	Required	Nullable	Default
dashboardId	string	required	non-null	—

Query parameters: none.

200

Response fields
Field	Type	Required	Nullable	Default
data	object	required	non-null	—
data.id	string	required	non-null	—
data.companyId	string	required	non-null	—
data.workspaceId	string	required	non-null	—
data.name	string	required	non-null	—
data.description	string	optional	nullable	—
data.renderer	"widget-grid" \| "custom-html"	required	non-null	—
data.queries	array	required	non-null	—
data.definition	unknown	required	non-null	—
data.filters	object	required	non-null	—
data.filters.filters	array	optional	non-null	—
data.filters.dateRange	string	optional	non-null	—
data.boundDimensions	object	required	non-null	—
data.freeDimensions	array	required	non-null	—
data.groupings	object	optional	nullable	—
data.system	boolean	required	non-null	—
data.color	string	optional	nullable	—
data.icon	string	optional	nullable	—
data.createdBy	string	required	non-null	—
data.createdAt	unknown	required	non-null	—
data.updatedAt	unknown	required	non-null	—
data.revision	object	required	non-null	—
data.revision.updatedAt	string	required	non-null	—
data.revision.renderDigest	string	required	non-null	—
data.interactionAuthoring	object	required	non-null	—
data.interactionAuthoring.capabilities	object	required	non-null	—
data.interactionAuthoring.planClasses	object	required	non-null	—

Declared failures
NOT_FOUND	404 — not retryable
VALIDATION_ERROR	400 — not retryable

This method returns the current state it read.

Schematic only. Replace placeholders with real values and include all required nested fields.

GET /api/v1/dashboards/{dashboardId} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>