Dashboard structure and layout
Organization of the dashboard with the required widgets.
JSON design elements
To design a JSON API, you must identify the major elements of the API. JSON is built on two structures:- A collection of name-value pairs identified by elements.
- An ordered list of values.
| Element | Required | Type | Description |
|---|---|---|---|
| id | Yes | String | The unique dashboard ID. |
| title | No | String | Text to be displayed as the dashboards's title. |
| description | No | String | Text to be displayed along with dashboards's title. |
| dashboardType | No | String | Dashboard type identifies the start day of the week. By default, it is MONDAY. If for some wireless/wireline type of dashboards, it is different, this element value must be set to wireless/wireline. The week start value for that type is used. |
| totalrows | Yes | Number | Total number of rows in the layout. |
| totalcols | Yes | Number | Total number of columns in the layout. |
| stores | Yes | Object | An array of all the stores used in dashboard. |
| filterbar | No | Object | An object that defines the behavior of filter bar on dashboard. |
| widgets | Yes | Object | An array of widgets to be shown or included as data source change. |
