Understanding Pagination

As a general rule, Catalyst Manager API pagination is based on a snapshot of data at the time the API is invoked. There is no guarantee of data consistency between different API invocations.

Catalyst Manager API queries data from three different data sources: configuration databases, stats databases, and devices. These three data source have different ways of handling pagination. For API queries on a configuration database, pagination is performed with the "offset" and "limit" query parameters, 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 pagination behavior is determined by the device.

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. Catalyst Manager imposes a 250 concurrent sessions rate limit.

From 20.6 release, the following rate-limits are introduced: Bulk API: 48 requests/minute All other API: 100 requests/second

Note: Real-time monitoring API are very CPU intensive and should be used for troubleshooting only. These should not be used continuously for active monitoring of the devices.