dashboard.get

    The method allows to retrieve dashboards according to the given parameters.

    This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See for more information.

    Parameters

    The method supports the following parameters.

    (integer/array) Returns either:

    • an array of objects;
    • the count of retrieved objects, if the countOutput parameter has been used.

    Examples

    Retrieving a dashboard by ID

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "dashboardid": "1",
    6.                    "name": "Dashboard",
    7.                    "userid": "1",
    8.                    "private": "0",
    9.                    "display_period": "30",
    10.                    "auto_start": "1",
    11.                    "users": [],
    12.                    "userGroups": [],
    13.                    "pages": [
    14.                        {
    15.                            "dashboard_pageid": "1",
    16.                            "name": "",
    17.                            "display_period": "0",
    18.                            "widgets": [
    19.                                {
    20.                                    "widgetid": "9",
    21.                                    "type": "systeminfo",
    22.                                    "name": "",
    23.                                    "x": "12",
    24.                                    "y": "8",
    25.                                    "width": "12",
    26.                                    "height": "5",
    27.                                    "view_mode": "0",
    28.                                    "fields": []
    29.                                },
    30.                                {
    31.                                    "widgetid": "8",
    32.                                    "type": "problemsbysv",
    33.                                    "name": "",
    34.                                    "x": "12",
    35.                                    "y": "4",
    36.                                    "width": "12",
    37.                                    "height": "4",
    38.                                    "view_mode": "0",
    39.                                    "fields": []
    40.                                },
    41.                                {
    42.                                    "widgetid": "7",
    43.                                    "type": "problemhosts",
    44.                                    "name": "",
    45.                                    "x": "12",
    46.                                    "y": "0",
    47.                                    "width": "12",
    48.                                    "height": "4",
    49.                                    "view_mode": "0",
    50.                                    "fields": []
    51.                                },
    52.                                {
    54.                                    "name": "",
    55.                                    "x": "6",
    56.                                    "y": "9",
    57.                                    "width": "6",
    58.                                    "height": "4",
    59.                                    "view_mode": "0",
    60.                                    "fields": []
    61.                                },
    62.                                {
    63.                                    "widgetid": "5",
    64.                                    "type": "web",
    65.                                    "name": "",
    66.                                    "x": "0",
    67.                                    "y": "9",
    68.                                    "width": "6",
    69.                                    "height": "4",
    70.                                    "view_mode": "0",
    71.                                    "fields": []
    72.                                },
    73.                                {
    74.                                    "widgetid": "4",
    75.                                    "type": "problems",
    76.                                    "name": "",
    77.                                    "x": "0",
    78.                                    "y": "3",
    79.                                    "width": "12",
    80.                                    "height": "6",
    81.                                    "view_mode": "0",
    82.                                    "fields": []
    83.                                },
    84.                                {
    85.                                    "widgetid": "3",
    86.                                    "type": "favmaps",
    87.                                    "name": "",
    88.                                    "x": "8",
    89.                                    "y": "0",
    90.                                    "width": "4",
    91.                                    "height": "3",
    92.                                    "view_mode": "0",
    93.                                    "fields": []
    94.                                },
    95.                                {
    96.                                    "widgetid": "1",
    97.                                    "type": "favgraphs",
    98.                                    "name": "",
    99.                                    "x": "0",
    100.                                    "y": "0",
    101.                                    "width": "4",
    102.                                    "height": "3",
    103.                                    "view_mode": "0",
    104.                                    "fields": []
    105.                                }
    106.                            ]
    107.                        },
    108.                        {
    109.                            "dashboard_pageid": "2",
    110.                            "name": "",
    111.                            "display_period": "0",
    113.                        },
    114.                            "dashboard_pageid": "3",
    115.                            "name": "Custom page name",
    116.                            "display_period": "60",
    117.                            "widgets": []
    118.                        }
    119.                    ]
    120.                },
    121.                {
    122.                    "dashboardid": "2",
    123.                    "name": "My dashboard",
    124.                    "userid": "1",
    125.                    "private": "1",
    126.                    "display_period": "60",
    127.                    "auto_start": "1",
    128.                    "users": [
    129.                        {
    130.                            "userid": "4",
    131.                            "permission": "3"
    132.                        }
    133.                    ],
    134.                    "userGroups": [
    135.                        {
    136.                            "usrgrpid": "7",
    137.                            "permission": "2"
    138.                        }
    139.                    ],
    140.                    "pages": [
    141.                        {
    142.                            "dashboard_pageid": "4",
    143.                            "name": "",
    144.                            "display_period": "0",
    145.                            "widgets": [
    146.                                {
    147.                                    "widgetid": "10",
    148.                                    "type": "problems",
    149.                                    "name": "",
    150.                                    "x": "0",
    151.                                    "y": "0",
    152.                                    "width": "12",
    153.                                    "height": "5",
    154.                                    "view_mode": "0",
    155.                                    "fields": [
    156.                                        {
    157.                                            "type": "2",
    158.                                            "name": "groupids",
    159.                                            "value": "4"
    160.                                        }
    161.                                    ]
    162.                                }
    163.                            ]
    164.                        }
    165.                    ]
    166.                }
    167.            ],
    168.            "id": 1
    169.        }

    Source