Real-Time APIs
Query current state directly from one device through /device endpoints.
Best for interactive troubleshooting and immediate inspection.
Monitoring API Overview
Cisco Catalyst SD-WAN Manager exposes three complementary monitoring API categories. The correct category depends on whether you need a live device view, historical analysis, or a large batched export.
The Three Monitoring API Categories
Section titled “The Three Monitoring API Categories”Statistics APIs
Query historical records stored in the SD-WAN Manager NMS statistics database through /statistics endpoints.
Best for filtering, sorting, trending, and aggregation.
Bulk APIs
Retrieve state or statistics for many devices in batches through /data and /v2/data endpoints.
Best for large exports and inventory-wide collection.
| Category | Base path | Data source | Scope | Typical use |
|---|---|---|---|---|
| Real-time | /device |
Queried directly from a device | One selected device | Inspect BFD, ARP, interfaces, routes, system state, and other live operational data |
| Statistics | /statistics |
Manager statistics database | Stored records selected by a query | Analyze historical performance, calculate aggregates, and identify trends |
| Bulk | /data, /v2/data |
Batched device state or Manager statistics | Multiple devices and large result sets | Export state or millions of statistics records with cursor-based pagination |
How to Choose
Section titled “How to Choose”| Requirement | Use |
|---|---|
| What is happening on this device right now? | Real-Time APIs |
| What happened over a time range? | Statistics APIs |
| How can I retrieve data for many devices or a very large result set? | Bulk APIs |
| How often can I call these APIs safely? | Monitoring Best Practices |
| Which API should I use for a common monitoring task? | Common Use Cases |
Real-time data is not a substitute for historical monitoring, and a bulk export is not a substitute for a focused troubleshooting call. Choose the API category that matches the data source and scale required by the application.