Get Dashboard

This endpoints retrieves a specific Dashboard.

Request

To retrieve a specific Dashboard please make a GET request to the following URL:

HTTP Method

URL

GET

https://industrial.api.ubidots.com/api/v2.0/dashboards/<dashboard_key>/

Path Parameters

Parameter

Type

Description

dashboard_key

String

The id or label of the Dashboard, label should use the prefix ~

Query Parameters

Parameter

Type

Use

Description

token

String

Authentication

Authentication Token can optionally be sent as a query parameter.

fields

Comma separated list

Dynamic Fields

Allows to dynamically specify the fields that should be included in the response object

Header

Parameter

Required?

Description

X-Auth-Header

Yes

Authentication Token of account

$ curl -X GET 'https://industrial.api.ubidots.com/api/v2.0/dashboards/<dashboard_key>/' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73'
{
    "url": "https://industrial.api.ubidots.com/api/v2.0/dashboards/abcdefghi12345678",
    "id": "abcdefghi12345678",
    "organization": null,
    "label": "demo_dashboard",
    "name": "Demo Dashboard",
    "description": "",
    "timeframe": {
        "endDate": "now/d",
        "startDate": "now-7d"
    },
    "tags": [],
    "context": {
        "size": null,
        "_isNew": true,
        "isDynamic": true,
        "displayName": "name",
        "__customStyle": {
              "dashboard": {
                  "color": "#5e5e5e",
                  "backgroundColor": "#f2f2f2"
              },
              "contextBar": {
                  "color": "#ffffff",
                  "title": {
                      "fontSize": 30,
                      "fontFamily": "Helvetica",
                      "fontWeight": "bold"
                  },
                  "fontSize": 14,
                  "fontFamily": "Helvetica",
                  "boxShadow": "3px 3px 5px 6px #ccc",
                  "borderRadius": "0px 0px 7px 7px",
                  "backgroundColor": "#192c54"
              }
          },
        "defaultDevice": "abcdefghijkl1234567890",
        "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/abcdefghjasdfj12345678/widgets",
    "widgetsNumber": 11,
    "isActive": true,
    "createdAt": "2020-05-24T15:39:05.838572Z"
}
{
    "code": 400001,
    "message": "Validation Error.",
    "detail": {
        ....
    }
}
{
    "code": 401001,
    "message": "Authentication credentials were not provided.",
    "detail": "Authentication credentials were not provided."
}

Response

Returns a Dashboard object with the requested Dashboard.