Dashboard Object

Describes the JSON object of a Dashboard.

A Dashboard in Ubidots can store one or more Widgets. Dashboards are used to visualize data in easy-to-read widgets.

idStringId of Dashboard
labelStringLabel of Dashboard
nameStringName of Device Type
createdAtStringDate Dashboard was created
descriptionStringDescription of Dashboard
organizationStringOrganization Dashboard is assigned to
timeframeObjectThe timeframe object contains 2 keys: endDate and startDate representing the date range of the Dashboards data visualization
orderNumberOrder in which dashboards are presented to user. Dashboards are order first by order and then by date.
tagsArrayTags of Dashboard
contextObjectContext Data of Array
isEditableBooleanTrue if Dashboard can be edited
orderNumberProperties of Device Type
widgetsStringUrl of widgets of Dashboard
widgetsCountNumberNumber of Widgets in Dashboard
isActiveBooleanTrue if Dashboard is active
urlStringUrl of Dashboard

Context Object of a Dashboard

sizeJSONThe maximum resolution of a Dashboard, is a JSON Object with width and height key e.g. {"width":1024, "height":768}, default is null
isDynamicBooleanTrue if Dashboard is a Dynamic Dashboard
displayNameStringDashboard attribute that's used to be displayed, e.g. label, id, or name
__customStyleObjectAccepts all CSS attributes to customize the Dashboard
defaultDeviceStringId of default Device, only for Dynamic Dashboards
hasBackgroundBooleanTrue if Dashboard has a custom background
widgetOpacityNumberValue between 0 and 1 representing the opacity of Widgets in the Dashboard, default is 1
floatingWidgetsBooleanWhen true Widgets can be freely positioned in the dashboard, when false, Widgets adhere to the top
timestampFormatStringFormat of timestampe, default is MM/DD/YYYY HH:mm
deviceFilterTypeStringA Dashboard can have either of the following three entities as default: all (a Device), device_group (a Device Group), and a device_type (a Device Type), only applies if isDynamic = true
widgetVerticalSpacingNumberVertical spacing between Widgets in Dashboard
widgetHorizontalSpacingNumberHorizontal spacing between Widgets in Dashboard
    "url": "https://industrial.api.ubidots.com/api/v2.0/dashboards/abcdefgh1234567890",
    "id": "abcdefgh1234567890",
    "organization": null,
    "label": "demo-dashboard",
    "name": "Demo Dashboard",
    "description": "",
    "timeframe": {
        "endDate": "now/d",
        "startDate": "now-7d"
    "tags": [],
    "context": {
        "size": null,
        "isDynamic": true,
        "displayName": "name",
        "__customStyle": null,
        "defaultDevice": "abcdefghi1234567890",
        "hasBackground": false,
        "widgetsOpacity": 1,
        "floatingWidgets": false,
        "timestampFormat": "MM/DD/YYYY HH:mm",
        "deviceFilterType": "all",
        "deviceFilterEntityId": null,
        "widgetVerticalSpacing": 10,
        "widgetHorizontalSpacing": 10
    "isEditable": true,
    "order": 1,
    "widgets": "https://industrial.api.ubidots.com/api/v2.0/dashboards/abcdefghijkl1234567890/widgets",
    "widgetsNumber": 11,
    "isActive": true,
    "createdAt": "2020-05-24T15:39:05.838572Z"