report.get

    The method allows to retrieve scheduled reports 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 User roles 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 report data

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "reportid": "1",
    6.                    "userid": "1",
    7.                    "name": "Weekly report",
    8.                    "dashboardid": "1",
    9.                    "period": "1",
    10.                    "cycle": "1",
    11.                    "start_time": "43200",
    12.                    "weekdays": "31",
    13.                    "active_since": "2021-04-01",
    14.                    "active_till": "2021-08-31",
    15.                    "subject": "Weekly report",
    16.                    "message": "Report accompanying text",
    18.                    "state": "1",
    19.                    "lastsent": "1613563219",
    20.                    "info": "",
    21.                    "users": [
    22.                        {
    23.                            "userid": "1",
    24.                            "access_userid": "1",
    25.                            "exclude": "0"
    26.                        },
    27.                        {
    28.                            "userid": "2",
    29.                            "access_userid": "0",
    30.                            "exclude": "1"
    31.                        }
    32.                    ],
    33.                    "user_groups": [
    34.                        {
    35.                            "usrgrpid": "7",
    36.                            "access_userid": "0"
    37.                        }
    38.                    ]
    39.                },
    40.                {
    41.                    "reportid": "2",
    43.                    "name": "Monthly report",
    44.                    "period": "2",
    45.                    "cycle": "2",
    46.                    "start_time": "0",
    47.                    "weekdays": "0",
    48.                    "active_since": "2021-05-01",
    49.                    "active_till": "",
    50.                    "subject": "Monthly report",
    51.                    "message": "Report accompanying text",
    52.                    "status": "1",
    53.                    "description": "",
    54.                    "state": "0",
    55.                    "lastsent": "0",
    56.                    "info": "",
    57.                    "users": [
    58.                        {
    59.                            "userid": "1",
    60.                            "access_userid": "1",
    61.                            "exclude": "0"
    62.                        }
    63.                    ],
    64.                    "user_groups": []
    65.                }
    66.            ],
    68.        }

    Source

    CReport::get() in ui/include/classes/api/services/CReport.php.