getReportsList

This method returns the list of scheduled reports, according to the parameters received.

Services

This method requires you to place the {service} name in the API URL. The allowed services are:

computers, for "Computers and Virtual Machines"
virtualmachines, for "Virtual Machines"

For example, the request URL for the virtual machines service is:

https://YOUR-HOSTNAME/api/v1.0/jsonrpc/reports/virtualmachines

Parameters

Parameter	Type	Optional	Description
`name`	String	Yes	The name of the report.
`type`	Number	Yes	The report type. The available types are: `1` - Antiphishing Activity `2` - Blocked Applications `3` - Blocked Websites `4` - Customer Status Overview `5` - Data Protection `6` - Device Control Activity `7` - Endpoint Modules Status `8` - Endpoint Protection Status `9` - Firewall Activity `10` - License Status `12` - Malware Status `14` - Network Status `15` - On demand scanning `16` - Policy Compliance `17` - Security Audit `18` - Security Server Status `19` - Top 10 Detected Malware `20` - Top 10 Infected Companies `21` - Top 10 Infected Endpoints `22` - Update Status `25` - Virtual Machine Network Status `30` - Endpoint Encryption Status `31` - HyperDetect Activity `32` - Network Patch Status `33` - Sandbox Analyzer Failed Submissions `34` - Network Incidents `36` - Integrity Monitoring Activity `37` - Integrity Monitoring Configuration Changes
`page`	Number	Yes	The results page number. Default page number is `1`.
`perPage`	Number	Yes	The number of items displayed in a page. The upper limit is 100 items per page. Default value: 30 items per page.

Return value

This method returns an Object containing information about the reports. The returned object contains:

page - the current page displayed
pagesCount - the total number of available pages
perPage - the total number of returned items per page
items - the list of reports. Each entry in the list has the following fields:
- ID, the ID of the report
- name, the name of the report
- type, the report type, as described in the Parameters table
- occurrence, the time interval when the report runs. The occurrence can be: 2 - hourly, 3 - daily, 4 - weekly or 5 - monthly. Please mind that value 1 (instant report) is excluded from the valid options.
total - the total number of items

Example

Request:

  {
       "params": {
           "type": 2,
           "page": 2,
           "perPage": 4
       },
       "jsonrpc": "2.0",
       "method": "getReportsList",
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

Response:

  {
      "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
      "jsonrpc":"2.0",
      "result": {
           "page": 2,
           "pagesCount": 11,
           "perPage": 5,
           "total": 54
           "items": [
               {
                   'id': '5638cdceb1a43d46137b23c6',
                   'name': 'My report 1',
                   'occurrence': 2,
                   'type': 2
               },
               {
                   'id': '5638d7f8b1a43d49137b23c9',
                   'name': 'My report 2',
                   'occurrence': 4,
                   'type': 2
               },
               {
                   'id': u'563b271bb1a43d21077b23c8',
                   'name': 'My report 3',
                   'occurrence': 4,
                   'type': 2
               },
               {
                   'id': '563a289eb1a43d2f617b23c6',
                   'name': 'My report 4',
                   'occurrence': 2,
                   'type': 2
               }
           ]
      }
  }

In this section:

getReportsList

Services

Parameters

Return value

Example

Search results