Skip to main content
Viptela is now part of Cisco.
Support
Product Documentation
Viptela Documentation

Statistics

Bulk API calls returning statistics for vManage components:

Alarms

Display statistics about device alarms.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/alarm?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Application-Aware Routing Status

Display statistics about data traffic characteristics for all operational router data plane tunnels.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/approutestatsstatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Audit Logs

Display statistics about device audit logs.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/auditlog?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Bridge Interfaces

Display statistics about bridge interfaces on a router.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/bridgeinterfacestatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Bridge MAC Addresses

Display statistics about MAC addresses learned by bridging domains.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/bridgemacstatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Cflowd

Display router cflowd packet statistics.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/cflowdstatistics?startDate=yyyy-mm-dd hh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

CloudExpress Service

Display statistics about CloudExpress service.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/cloudxstatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Device Configuration

Display device configuration statistics.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/deviceconfiguration?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Device Events

Display notifications about events that have occurred on Viptela devices.

URL: https://vmanage-ip-address/dataservice/data/device/state/deviceevent?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Device System Status

Display time and process information for devices, as well as CPU, memory, and disk usage data.

URL: https://vmanage-ip-address/dataservice/data/device/state/devicesystemstatusstatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone Query String

Response Content Type: application/json

Response Object: See Response Object below.

DPI

Display summary statistics for router DPI flows.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/dpistatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Flow Logs

Display statistics about packet flow logs.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/flowlogstatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Interfaces

Display interface statistics.

URL: https://vmanage-ip-address/dataservice/data/device/state/interfacestatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

WLAN Clients

Display statistics about clients connected to a WLAN.

URL: https://vmanage-ip-address/dataservice/data/device/statistics/wlanclientinforstatistics?startDate=yyyy-mm-ddThh:mm:ss&endDate=yyyy-mm-ddThh:mm:ss

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

startDate

Yes Starting time, in the format yyyy-mm-ddThh:mm:ss. Query String
endDate Yes Ending time, in the format yyyy-mm-ddThh:mm:ss. Query String
count Optional Number of records to query per page. Query Number
scrollId Optional Scroll identifier of the current bulk session. It acts as a pointer to the next data entry. The scrollId expires 10 minutes after it is returned in a call. Query String
timeZone Optional Three-letter timezone. Query String

Response Content Type: application/json

Response Object: See Response Object below.

Response Object for Bulk Statistics API Calls

The bulk statistics API call responses have the following format:

{
   "header": {
      "generatedOn": timestamp,
      "viewKeys": {
         
      },
      "fields": [
         column headers for output fields
      ],
      "chart": {}
   },
   "data": [
      returned data
   ],
   "pageInfo": {
      "startTime": "", start date of the current document set
      "endTime": "", end date of the current document set
      "scrollId": "" Scroll ID,
      "hasMoreData": [true | false] whether there is more data,
      "count": number of documents returned in the current request
   }
}

Example

The URL in the following example displays cflowd statistics within a specified time range:

https://vmanage-ip-address/dataservice/data/device/statistics/cflowdstatistics
?startDate=2016-07-07T00:00:00&endDate=2016-07-07T15:00:00

The following output shows the data returned. The output is returned on one line. Line breaks have been added for readability. The scrollId field in the pageInfo section at the end of the output is a pointer to the next data entry. The hasMoreData field in pageInfo section at the end of the output indicates that more cflowd statistics are available.

{
"header":
{"generatedOn":1467932473449,
"viewKeys":{"uniqueKey":[],
"preferenceKey":"grid-raw_cflowdstatistics"},
"columns":[
    {"title":
        "Device IP","property":"vdevice_name","dataType":"ip"},
    {"title":
        "Host name","property":"host_name","dataType":"string"},
    {"title":
        "Device Model","property":"device_model","dataType":"string"},
    {"title":
        "Time","property":"statcycletime",
        "displayFormat":"DD MMM YYYY h:mm:ss A z",
        "inputFormat":"unix-time","dataType":"date"},
    {"title":
        "entry_time","property":"entry_time",
        "displayFormat":"DD MMM YYYY h:mm:ss A z",
        "inputFormat":"unix-time","dataType":"date"},
    {"title":
        "Start Time","property":"start_time",
        "displayFormat":"yyyy-MM-dd'T'HH:mm",
       "inputFormat":"unix-time","dataType":"date"},
    {"title":
        "Total Pkts",
        "property":"total_pkts",
        "dataType":"number"},
    {"title":
        "Total bytes",
        "property":"total_bytes",
        "dataType":"number"}
],
"fields":[
    {"property":"vdevice_name","dataType":"ip"},
    {"property":"host_name","dataType":"string"},
    {"property":"device_model","dataType":"string"},
    {"property":"statcycletime","dataType":"date"},
    {"property":"entry_time","dataType":"date"},
    {"property":"vip_idx","dataType":"number"},
    {"property":"vpn_id","dataType":"number"},
    {"property":"remote_system_ip","dataType":"string"},
    {"property":"local_color","dataType":"string"},
    {"property":"remote_color","dataType":"string"},
    {"property":"proto","dataType":"string"},
    {"property":"src_ip","dataType":"string"},
    {"property":"dest_ip","dataType":"string"},
    {"property":"src_port","dataType":"number"},
    {"property":"dest_port","dataType":"number"},
    {"property":"dscp","dataType":"number"},
    {"property":"ip_proto","dataType":"number"},
    {"property":"ingress_intf","dataType":"string"},
    {"property":"egress_intf","dataType":"string"},
    {"property":"start_time","dataType":"date"},
    {"property":"total_pkts","dataType":"number"},
    {"property":"total_bytes","dataType":"number"},
    {"property":"start_time","dataType":"number"},
    {"property":"total_pkts","dataType":"number"},
    {"property":"start_time","dataType":"number"},
    {"property":"total_pkts","dataType":"number"},
    {"property":"total_bytes","dataType":"number"},
    {"property":"flow_active","dataType":"string"}
],
"chart":{}},
"data":[
    {"vdevice_name":"172.16.251.19",
        "host_name":"vm6019",
        "statcycletime":1467877201570,
        "device_model":"vedge-cloud",
        "entry_time":1467702002189,"vip_idx":1229,"vpn_id":1,
        "remote_system_ip":"NA","local_color":"NA",
        "remote_color":"NA",
        "src_ip":"144.200.168.122",
        "dest_ip":"74.240.139.218",
        "src_port":30999,
        "dest_port":23989,
        "dscp":48,
        "ip_proto":18,
        "ingress_intf":"cpu",
        "egress_intf":"ge0\/0",
        "total_pkts":2734203,
        "total_bytes":99979047,
        "flow_active":"false",
        "tunnel_color":"NA:NA",
        "destination":"74.240.139.218:23989",
        "id":"AVXETKjlfZiW1snFrC7n"
    },
    {"vdevice_name":"172.16.251.19",
        "host_name":"vm6019",
        "statcycletime":1467877201570,
        "device_model":"vedge-cloud",
        "entry_time":1467702002689,
        "vip_idx":351,"vpn_id":1,
        "remote_system_ip":"NA",
        "local_color":"NA",
        "remote_color":"NA",
        "src_ip":"20.99.232.228",
        "dest_ip":"122.100.201.80",
        "src_port":61921,
        "dest_port":11316,
        "dscp":48,
        "ip_proto":18,
        "ingress_intf":"cpu",
        "egress_intf":"ge0\/0",
        "total_pkts":7169028,
        "total_bytes":12981555,
        "flow_active":"false",
        "tunnel_color":"NA:NA",
        "destination":"122.100.201.80:11316",
        "id":"AVXETKjlfZiW1snFrC7o"
    }
],

The last section in the returned data, named pageInfo, reports the range of devices for which information has been returned. The scrollId field identifies the current bulk session and acts as a pointer to the next data entry. Use this value to scroll through data in the bulk session one entry at a time. The scroll identifier expires after 10 minutes. The moreEntries field indicates whether more entries are present.

"pageInfo":{
    "startTime":"1467877201570",
    "endTime":"1467877201570",
    "scrollId":"cXVlcnlUaGVuRmV0Y2g7MjA7OTk4MDU6Z3IxbFltaHRUOXlKZkxBUHFuTDBCUTs5OTgwMTpncjFsWW1odFQ5eUpmTEFQcW5MMEJROzk5ODAyOmdyMWxZbWh0VDl5SmZMQVBxbkwwQlE7OTk4MDM6Z3IxbFltaHRUOXlKZkxBUHFuTDBCUTs5OTgwNjpncjFsWW1odFQ5eUpmTEFQcW5MMEJROzk5ODA3OmdyMWxZbWh0VDl5SmZMQVBxbkwwQlE7OTk4MDQ6Z3IxbFltaHRUOXlKZkxBUHFuTDBCUTs5OTgwODpncjFsWW1odFQ5eUpmTEFQcW5MMEJROzk5ODA5OmdyMWxZbWh0VDl5SmZMQVBxbkwwQlE7OTk4MTA6Z3IxbFltaHRUOXlKZkxBUHFuTDBCUTs5OTgxMTpncjFsWW1odFQ5eUpmTEFQcW5MMEJROzk5ODEyOmdyMWxZbWh0VDl5SmZMQVBxbkwwQlE7OTk4MTM6Z3IxbFltaHRUOXlKZkxBUHFuTDBCUTs5OTgxNDpncjFsWW1odFQ5eUpmTEFQcW5MMEJROzk5ODE1OmdyMWxZbWh0VDl5SmZMQVBxbkwwQlE7OTk4MTY6Z3IxbFltaHRUOXlKZkxBUHFuTDBCUTs5OTgxNzpncjFsWW1odFQ5eUpmTEFQcW5MMEJROzk5ODE4OmdyMWxZbWh0VDl5SmZMQVBxbkwwQlE7OTk4MTk6Z3IxbFltaHRUOXlKZkxBUHFuTDBCUTs5OTgyMDpncjFsWW1odFQ5eUpmTEFQcW5MMEJROzA7_2",
    "hasMoreData":true,
    "count":50,
    "totalCount":9423934
  }
}

If more entries are present, issue a second call, specifying the scrollId as the starting point:

https://vmanage-ip-address/dataservice/data/device/statistics/cflowdstatistics?scrollId=cXVlcn...

Repeat the previous command, with the appropriate ScrollID, until the hasMoreData field returns as false.

Additional Information

Using the vManage REST API

  • Was this article helpful?