Understanding Pagination

As a rule, the system bases Cisco Catalyst SD-WAN Manager API pagination on a snapshot of data at the time you invoke the API. There is no guarantee of data consistency between different API invocations.

Cisco Catalyst SD-WAN Manager API queries data from three different data sources: configuration databases, stats databases, and devices. These three data sources have different ways of handling pagination. For API queries on a configuration database, use the "offset" and "limit" query parameters to perform pagination, such as GET /template/feature?offset=1&limit=10. For API queries on a stats database, it uses the "scrollId" and "count" query parameter, such as GET /statistics/approute/page?scrollId=DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ&count=10.

For API queries on a device, the device determines the pagination behavior.

Sorting and Filtering Results

Currently sorting and filtering are only available for device stats and statistics APIs. Refer to the Overview > Quick Start > Device State and Statistics section for details.

Rate Limits on Results

For statistics bulk API /dataservice/data/device/statistics/ requests, the rate limit is two concurrent requests at any given time. Cisco Catalyst SD-WAN Manager imposes a 250 concurrent sessions rate limit.

From the 20.6 release, the system introduces the following rate limits: Bulk API: 48 requests/minute All other API: 100 requests/second.

Note: Use real-time monitoring APIs, which are very CPU intensive, for troubleshooting only. Avoid using them continuously for active monitoring of the devices.