Get #

Retrieves an existing dashboard inside a tenant index.

Returns an error if the dashboard does not exist.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/dashboard/:index/:id
Method: GET

Javascript #

kuzzle.query({
  controller: 'dashboard-builder/dashboard',
  action: 'get',
  index: '<index>',
  id: '<dashboard-id>',
});

Arguments #

Arguments	Type	Description
`index`	string	Index name where the dashboard exists.
`id`	string	Unique identifier of the dashboard to retrieve.

Response #

The response contains the dashboard document.

Example Response #

{
  "_id": "dashboard-id",
  "_source": {
    "label": "Dashboard Label",
    "layout": [
      {
        "settings": { "key": "value" },
        "x": 0,
        "y": 0,
        "w": 4,
        "h": 2,
        "i": "widget-id",
        "name": "Widget Name",
        "mobileLayout": {
          "x": 0,
          "y": 0,
          "w": 2,
          "h": 1
        }
      }
    ],
    "icon": "string",
    "defaultDateTimeRange": {
      "relativeDateRange": "string",
      "time": {
        "start": "string",
        "end": "string"
      }
    },
    "refreshInterval": "string",
    "layoutPrecision": 12,
    "template": {
      "category": "string",
      "model": "string"
    }
  }
}

Dashboard Properties #

Arguments	Type	Description
`label`	string	A descriptive name for the dashboard.
`layout`	array	Layout configuration of the dashboard widgets.
`icon`	string	FontAwesome icon for the dashboard.
`defaultDateTimeRange`	object	Default date and time range for the dashboard.
`refreshInterval`	string	Refresh interval for the dashboard.
`layoutPrecision`	number	Number of columns for the dashboard grid.
`template`	object	Template configuration for the dashboard.

Layout Properties #

Arguments	Type	Description
`settings`	object	Specific settings of the widget.
`x`	number	X position of the widget in the layout.
`y`	number	Y position of the widget in the layout.
`w`	number	Width of the widget.
`h`	number	Height of the widget.
`i`	string	ID of the widget.
`name`	string	Name of the widget.
`mobileLayout`	object	Layout configuration for mobile view.

DefaultDateTimeRange Properties #

Arguments	Type	Description
`relativeDateRange`	string	Relative date range for the dashboard.
`time.start`	string	Start time in HH:mm:ss format.
`time.end`	string	End time in HH:mm:ss format.

Template Properties #

Arguments	Type	Description
`category`	string	Template category (e.g., asset, group).
`model`	string	Template model (e.g., Container).