Get all Dashboards

This endpoint retrieves all Dashboards.

Request

To retrieve all Dashboards please make a GET request to the following URL:

HTTP MethodURL
GEThttps://industrial.api.ubidots.com/api/v2.0/dashboards/

Query Parameter

ParameterTypeUseDescription
tokenStringAuthenticationAuthentication Token can optionally be sent as a query parameter.
pageNumberPaginationReturns the corresponding page of the result
page_sizeNumberPaginationNumber of items per page, if not provided takes default values of 50 (for variables 200)
created_atDateSortSort all Variables based on date created. Default descending.
labelStringSortSort by label
nameStringSortSort by name
fieldsComma separated listDynamic FieldsSpecify the fields that should be obtained in the response object.
searchStringSearchAllows to search on the following fields with one request label, name, description
idIdFilterFilter by Id
nameStringFilterFilter by name
labelStringFilterFilter by label
descriptionStringFilterFilter by description
tagsObjectFilterFilter by tags
contextObjectFilterFilter by context
timeframeObjectFilterFilter by timeframe
createdAtDateFilterFilter by date created
orderNumberFilterFilter by order
organizationRelated Organization FilterFilterFilter by Organization
isEditableBooleanFilterFilter by if Dashboard is editable (default is true)
publicCodesObjectFilterFilter by public codes

Header

ParameterRequired?Description
X-Auth-TokenYesAuthentication Token of account
$ curl -X GET 'https://industrial.api.ubidots.com/api/v2.0/dashboards/' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "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,
                "_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": "abcdefghijkl12345678",
                "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/abcdefgh12341234/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

An object with an array results containing all Dashboards.