Monitoring API Endpoints Table

Use Case	Real-time monitoring API endpoint and fields	Stats API endpoint
CPU utilization uptime and system resets	/device/system/status fields: cpu_user, cpu_system, cpu_idle, uptime-date, lastupdated	/statistics/system/
Track interface speed, uptime, utilization, bytes in/out, errors in/out	/device/interface fields: vdevice-dataKey, if-admin-status, if-oper-status, speed-mbps, uptime-date, lastupdated, rx-octets, tx-octets, rx-packets, tx-packets, rx-drops, tx-drops, rx-errors, tx-errors	/statistics/interface/aggregation
Tunnel up/down state	/data/device/state/BFDSessions fields: vdevice-host-name, system-ip, state	/statistics/approute
To get tunnel traffic	/device/tunnel/statistics fields: vdevice-host-name, system-ip, rx_octets, tx_octets	/statistics/approute

The stats processing frequency is 10 mins, so you will see data refreshed every 10 mins.

Examples

CPU utilization uptime and system resets POST /statistics/system/

Request payload example

{
    "query": {
        "condition": "AND",
        "rules": [
            {
                "value": [
                    "24"
                ],
                "field": "entry_time",
                "type": "date",
                "operator": "last_n_hours"
            },
            {
                "value": [
                    "172.16.200.10"
                ],
                "field": "vdevice_name",
                "type": "string",
                "operator": "in"
            }
        ]
    },
    "sort": [
        {
            "field": "entry_time",
            "type": "date",
            "order": "asc"
        }
    ],
    "aggregation": {
        "histogram": {
            "property": "entry_time",
            "type": "minute",
            "interval": 30,
            "order": "asc"
        }
    },
    "fields": [
        "entry_time",
        "cpu_user_new",
        "cpu_system"
    ]
}

Track interface speed, uptime, utilization, bytes in/out, errors in/out POST /statistics/interface/aggregation

Request payload example

{
    "query": {
        "condition": "AND",
        "rules": [
            {
                "value": [
                    "12"
                ],
                "field": "entry_time",
                "type": "date",
                "operator": "last_n_hours"
            },
            {
                "value": [
                    "172.16.200.10"
                ],
                "field": "vdevice_name",
                "type": "string",
                "operator": "in"
            },
            {
                "value": [
                    "GigabitEthernet2",
                    "GigabitEthernet1",
                    "Tunnel2",
                    "GigabitEthernet3",
                    "GigabitEthernet4",
                    "Loopback65528"
                ],
                "field": "interface",
                "type": "string",
                "operator": "in"
            }
        ]
    },
    "sort": [
        {
            "field": "entry_time",
            "type": "date",
            "order": "asc"
        }
    ],
    "aggregation": {
        "field": [
            {
                "property": "interface",
                "sequence": 1
            }
        ],
        "metrics": [
            {
                "property": "rx_pkts",
                "type": "sum"
            },
            {
                "property": "tx_pkts",
                "type": "sum"
            },
            {
                "property": "rx_octets",
                "type": "sum"
            },
            {
                "property": "tx_octets",
                "type": "sum"
            },
            {
                "property": "rx_drops",
                "type": "sum"
            },
            {
                "property": "tx_drops",
                "type": "sum"
            },
            {
                "property": "rx_errors",
                "type": "sum"
            },
            {
                "property": "tx_errors",
                "type": "sum"
            }
        ],
        "histogram": {
            "property": "entry_time",
            "type": "minute",
            "interval": 1,
            "order": "asc"
        }
    }
}

Tunnel up/down state POST /statistics/approute

Request payload example

{
    "query": {
        "condition": "AND",
        "rules": [
            {
                "value": [
                    "24"
                ],
                "field": "entry_time",
                "type": "date",
                "operator": "last_n_hours"
            },
            {
                "field": "vdevice_name",
                "operator": "in",
                "type": "string",
                "value": [
                    "172.16.200.10"
                ]
            },
            {
                "field": "app_probe_class",
                "operator": "in",
                "type": "string",
                "value": [
                    "None"
                ]
            },
            {
                "display": [
                    {
                        "name": "172.16.200.10:mpls-172.16.255.18:lte",
                        "name-hostname": "009_ximei_cedge2:mpls-ximei_cedge4:lte",
                        "proto": "IPSEC"
                    },
                    {
                        "name": "172.16.200.10:mpls-172.16.255.21:lte",
                        "name-hostname": "009_ximei_cedge2:mpls-ximei_cedge6:lte",
                        "proto": "IPSEC"
                    },
                    {
                        "name": "172.16.200.10:mpls-11.11.11.11:lte",
                        "name-hostname": "009_ximei_cedge2:mpls-ximei_cedge1:lte",
                        "proto": "IPSEC"
                    }
                ],
                "field": "name",
                "operator": "in",
                "type": "string",
                "value": [
                    "172.16.200.10:mpls-172.16.255.18:lte",
                    "172.16.200.10:mpls-172.16.255.21:lte",
                    "172.16.200.10:mpls-11.11.11.11:lte"
                ]
            }
        ]
    },
    "aggregation": {
        "field": [
            {
                "property": "name",
                "sequence": 1
            },
            {
                "property": "state",
                "sequence": 1
            },
            {
                "property": "proto",
                "sequence": 2
            }
        ],
        "histogram": {
            "property": "entry_time",
            "type": "minute",
            "interval": 30,
            "order": "asc"
        }
    }
}

To get tunnel traffic POST /statistics/approute

Request payload example

{
    "query": {
        "condition": "AND",
        "rules": [
            {
                "value": [
                    "24"
                ],
                "field": "entry_time",
                "type": "date",
                "operator": "last_n_hours"
            },
            {
                "field": "vdevice_name",
                "operator": "in",
                "type": "string",
                "value": [
                    "172.16.200.10"
                ]
            },
            {
                "field": "app_probe_class",
                "operator": "in",
                "type": "string",
                "value": [
                    "None"
                ]
            },
            {
                "display": [
                    {
                        "name": "172.16.200.10:mpls-172.16.255.18:lte",
                        "name-hostname": "009_ximei_cedge2:mpls-ximei_cedge4:lte",
                        "proto": "IPSEC"
                    },
                    {
                        "name": "172.16.200.10:mpls-172.16.255.21:lte",
                        "name-hostname": "009_ximei_cedge2:mpls-ximei_cedge6:lte",
                        "proto": "IPSEC"
                    },
                    {
                        "name": "172.16.200.10:mpls-11.11.11.11:lte",
                        "name-hostname": "009_ximei_cedge2:mpls-ximei_cedge1:lte",
                        "proto": "IPSEC"
                    }
                ],
                "field": "name",
                "operator": "in",
                "type": "string",
                "value": [
                    "172.16.200.10:mpls-172.16.255.18:lte",
                    "172.16.200.10:mpls-172.16.255.21:lte",
                    "172.16.200.10:mpls-11.11.11.11:lte"
                ]
            }
        ]
    },
    "aggregation": {
        "field": [
            {
                "property": "name",
                "sequence": 1
            },
            {
                "property": "state",
                "sequence": 1
            },
            {
                "property": "proto",
                "sequence": 2
            }
        ],
        "metrics": [
            {
                "property": "rx_octets",
                "type": "sum"
            },
            {
                "property": "tx_octets",
                "type": "sum"
            }
        ],
        "histogram": {
            "property": "entry_time",
            "type": "minute",
            "interval": 30,
            "order": "asc"
        }
    }
}