Get all Dashboards

Request

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

HTTP Method	URL
GET	`https://industrial.api.ubidots.com/api/v2.0/dashboards/`

Query Parameter

Parameter	Type	Use	Description
token	String	Authentication	Authentication Token can optionally be sent as a query parameter.
page	Number	Pagination	Returns the corresponding page of the result
page_size	Number	Pagination	Number of items per page, if not provided takes default values of 50 (for variables 200)
created_at	Date	Sort	Sort all Variables based on date created. Default descending.
label	String	Sort	Sort by label
name	String	Sort	Sort by name
fields	Comma separated list	Dynamic Fields	Specify the fields that should be obtained in the response object.
search	String	Search	Allows to search on the following fields with one request `label`, `name`, `description`
id	Id	Filter	Filter by Id
name	String	Filter	Filter by name
label	String	Filter	Filter by label
description	String	Filter	Filter by description
tags	Object	Filter	Filter by tags
context	Object	Filter	Filter by context
timeframe	Object	Filter	Filter by timeframe
createdAt	Date	Filter	Filter by date created
order	Number	Filter	Filter by order
organization	Related Organization Filter	Filter	Filter by Organization
isEditable	Boolean	Filter	Filter by if Dashboard is editable (default is `true`)
publicCodes	Object	Filter	Filter by public codes

Header

Parameter	Required?	Description
X-Auth-Token	Yes	[Authentication Token] (/reference/authentication) 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.