Paging in V2

All calls to the v2 API are returned by pages. Each resource will vary in default page size and depending on the Method will determine how pagination is performed. The response of the calls will contain the paging results needed to navigate through the pages. Below you can see an example of how this response looks:

"Pagination": {
        "TotalRows": 126,
        "HasMoreRows": true,
        "CurrentPage": 1,
        "TotalPages": 3,
        "PageSize": 50
    }

Paging requests are performed two ways depending on which API methods you are using. If you are using the GET method then paging requests are passed in through Query parameters. If you are using the POST method then paging requests are passed in the body of the request, you can see an example of each below:

You can specify further pages with the page parameter and set custom page size with the pageSize parameter.

📘

PageSize Return Limit

The maximum PageSize that can be returned is 2000. Setting a PageSize higher than 2000 may still return a successful API call, but the results will still only return up to 2000 pages.

Query Parameter

If you want to retrieve 50 environments at a time your request will look something like this:

GET /environments?pageSize=50

To get the next 50 Environments, your request will look something like this:

GET /environments?pageSize=50&page=2

To know how many pages are left you can reference the pagination object in the response to the request

Body

If you want to retrieve 25 systems at a time your request will look something like this

POST /metrics/evaluate

"Pagination": {
        "Page": 1,
        "PageSize": 25
    }

To get the next 25 systems, your request will look something like this:

"Pagination": {
        "Page": 2,
        "PageSize": 25
    }