Obtener Dashboard

Solicitud HTTP

Para obtener un Dashboard específico, haz una petición GET a la siguiente URL:

HTTP Method	URL
GET	`https://api.netux.com/api/v2.0/dashboards/<dashboard_key>/`

Parámetros de ruta

Parameter	Type	Description
`dashboard_key`	String	The id or label of the Dashboard, label should use the prefix `~`

Parámetros de consulta

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

Cabecera

Parameter	Required?	Description
`X-Auth-Token`	Yes	Authentication Token of account

$ curl -X GET 'https://api.netux.com/api/v2.0/dashboards/<dashboard_key>/' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73'

Respuesta

Devuelve un objeto Dashboard con el Dashboard solicitado.

{
    "url": "https://api.netux.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://api.netux.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."
}