Return one published dashboard visible to the current actor.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/reporting/dashboards/example"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/reporting/dashboards/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/reporting/dashboards/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Runtime dashboard detail visible to the current actor.
object
Runtime dashboard item visible to the current actor.
object
Dashboard definition id.
Dashboard key.
Dashboard title.
Dashboard description.
Dashboard ordering priority.
Current published version number.
How a dashboard renders its runtime surface.
Workspace UI page key for page-type dashboards.
Dashboard definition version.
object
Version id.
Version number scoped to the definition.
Publish timestamp.
Publishing user id.
Dashboard definition document.
object
Stable dashboard key.
Dashboard title.
Dashboard description.
Dashboard ordering priority.
Visibility policy for dashboard and report definitions.
object
Role ids that can see the definition.
User ids that can see the definition.
Permission keys that can see the definition.
Whether all permission keys are required instead of any one key.
Modules that must be active before the definition is visible.
Modules required by the dashboard.
Shared filter JSON definition.
Layout JSON definition.
Dashboard widgets.
Reusable data-source block used by dashboard widgets and report blocks.
object
Stable block id inside the definition document.
Display title.
Stable data-source reference stored by dashboard widgets and report blocks.
object
Identifies the authoring surface that provides a DataSource.
Stable provider identifier.
Human-readable provider key.
Descriptor fingerprint validated at publish time.
Parameter bindings keyed by data-source parameter key.
object
Parameter binding for one data-source parameter.
object
How a dashboard/report block supplies a data-source parameter value.
Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.
Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.
Defines renderer families that can consume a DataSource output.
Dashboard/report-owned runtime options that must stay within source-owned limits.
object
Configured page size for table/list sources.
Whether this block exposes export.
Configured export row limit.
Options of the renderer a dashboard widget or report block uses. Publish accepts bar options only for a bar chart and the share measure only for a source that declares a share field. A null option means its default.
object
Direction of the bars of a bar chart block.
How the bars of several series share one category.
What the length of a bar shows.
Drilldown configuration JSON.
Empty-state configuration JSON.
Error-behavior configuration JSON.
Export behavior JSON.
Dashboard refresh policy JSON.
How a dashboard renders its runtime surface.
Workspace UI page reference stored by page-type dashboards.
object
Manifest page key inside the active Workspace UI artifact.
Validated data-source references.
Published data-source reference snapshot for a definition version.
object
Widget or report block id.
Identifies the authoring surface that provides a DataSource.
Stable provider id.
Provider key.
Validated descriptor fingerprint.
Defines renderer families that can consume a DataSource output.
Materialized publishing user display name.
object
object
object
object
Example
{ "Data": { "Summary": { "Type": 0 }, "Published": { "Document": { "Widgets": [ { "DataSource": { "SourceKind": 0 }, "ParameterBindings": { "additionalProperty": { "Kind": 0 } }, "Renderer": 1, "RendererOptions": { "BarOrientation": 0, "BarArrangement": 0, "BarMeasure": 0 } } ], "Type": 0 }, "DataSources": [ { "SourceKind": 0, "Renderer": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Runtime dashboard detail visible to the current actor.
object
Runtime dashboard item visible to the current actor.
object
Dashboard definition id.
Dashboard key.
Dashboard title.
Dashboard description.
Dashboard ordering priority.
Current published version number.
How a dashboard renders its runtime surface.
Workspace UI page key for page-type dashboards.
Dashboard definition version.
object
Version id.
Version number scoped to the definition.
Publish timestamp.
Publishing user id.
Dashboard definition document.
object
Stable dashboard key.
Dashboard title.
Dashboard description.
Dashboard ordering priority.
Visibility policy for dashboard and report definitions.
object
Role ids that can see the definition.
User ids that can see the definition.
Permission keys that can see the definition.
Whether all permission keys are required instead of any one key.
Modules that must be active before the definition is visible.
Modules required by the dashboard.
Shared filter JSON definition.
Layout JSON definition.
Dashboard widgets.
Reusable data-source block used by dashboard widgets and report blocks.
object
Stable block id inside the definition document.
Display title.
Stable data-source reference stored by dashboard widgets and report blocks.
object
Identifies the authoring surface that provides a DataSource.
Stable provider identifier.
Human-readable provider key.
Descriptor fingerprint validated at publish time.
Parameter bindings keyed by data-source parameter key.
object
Parameter binding for one data-source parameter.
object
How a dashboard/report block supplies a data-source parameter value.
Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.
Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.
Defines renderer families that can consume a DataSource output.
Dashboard/report-owned runtime options that must stay within source-owned limits.
object
Configured page size for table/list sources.
Whether this block exposes export.
Configured export row limit.
Options of the renderer a dashboard widget or report block uses. Publish accepts bar options only for a bar chart and the share measure only for a source that declares a share field. A null option means its default.
object
Direction of the bars of a bar chart block.
How the bars of several series share one category.
What the length of a bar shows.
Drilldown configuration JSON.
Empty-state configuration JSON.
Error-behavior configuration JSON.
Export behavior JSON.
Dashboard refresh policy JSON.
How a dashboard renders its runtime surface.
Workspace UI page reference stored by page-type dashboards.
object
Manifest page key inside the active Workspace UI artifact.
Validated data-source references.
Published data-source reference snapshot for a definition version.
object
Widget or report block id.
Identifies the authoring surface that provides a DataSource.
Stable provider id.
Provider key.
Validated descriptor fingerprint.
Defines renderer families that can consume a DataSource output.
Materialized publishing user display name.
object
object
object
object
Example
{ "Data": { "Summary": { "Type": 0 }, "Published": { "Document": { "Widgets": [ { "DataSource": { "SourceKind": 0 }, "ParameterBindings": { "additionalProperty": { "Kind": 0 } }, "Renderer": 1, "RendererOptions": { "BarOrientation": 0, "BarArrangement": 0, "BarMeasure": 0 } } ], "Type": 0 }, "DataSources": [ { "SourceKind": 0, "Renderer": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Runtime dashboard detail visible to the current actor.
object
Runtime dashboard item visible to the current actor.
object
Dashboard definition id.
Dashboard key.
Dashboard title.
Dashboard description.
Dashboard ordering priority.
Current published version number.
How a dashboard renders its runtime surface.
Workspace UI page key for page-type dashboards.
Dashboard definition version.
object
Version id.
Version number scoped to the definition.
Publish timestamp.
Publishing user id.
Dashboard definition document.
object
Stable dashboard key.
Dashboard title.
Dashboard description.
Dashboard ordering priority.
Visibility policy for dashboard and report definitions.
object
Role ids that can see the definition.
User ids that can see the definition.
Permission keys that can see the definition.
Whether all permission keys are required instead of any one key.
Modules that must be active before the definition is visible.
Modules required by the dashboard.
Shared filter JSON definition.
Layout JSON definition.
Dashboard widgets.
Reusable data-source block used by dashboard widgets and report blocks.
object
Stable block id inside the definition document.
Display title.
Stable data-source reference stored by dashboard widgets and report blocks.
object
Identifies the authoring surface that provides a DataSource.
Stable provider identifier.
Human-readable provider key.
Descriptor fingerprint validated at publish time.
Parameter bindings keyed by data-source parameter key.
object
Parameter binding for one data-source parameter.
object
How a dashboard/report block supplies a data-source parameter value.
Shared filter key when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Filter.
Static JSON value when Kind is Moltaro.Reporting.Models.ReportingParameterBindingKindEnum.Static.
Defines renderer families that can consume a DataSource output.
Dashboard/report-owned runtime options that must stay within source-owned limits.
object
Configured page size for table/list sources.
Whether this block exposes export.
Configured export row limit.
Options of the renderer a dashboard widget or report block uses. Publish accepts bar options only for a bar chart and the share measure only for a source that declares a share field. A null option means its default.
object
Direction of the bars of a bar chart block.
How the bars of several series share one category.
What the length of a bar shows.
Drilldown configuration JSON.
Empty-state configuration JSON.
Error-behavior configuration JSON.
Export behavior JSON.
Dashboard refresh policy JSON.
How a dashboard renders its runtime surface.
Workspace UI page reference stored by page-type dashboards.
object
Manifest page key inside the active Workspace UI artifact.
Validated data-source references.
Published data-source reference snapshot for a definition version.
object
Widget or report block id.
Identifies the authoring surface that provides a DataSource.
Stable provider id.
Provider key.
Validated descriptor fingerprint.
Defines renderer families that can consume a DataSource output.
Materialized publishing user display name.
object
object
object
object
Example
{ "Data": { "Summary": { "Type": 0 }, "Published": { "Document": { "Widgets": [ { "DataSource": { "SourceKind": 0 }, "ParameterBindings": { "additionalProperty": { "Kind": 0 } }, "Renderer": 1, "RendererOptions": { "BarOrientation": 0, "BarArrangement": 0, "BarMeasure": 0 } } ], "Type": 0 }, "DataSources": [ { "SourceKind": 0, "Renderer": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}