Several API methods return data in a paged format. This prevents clients and servers from being overwhelmed by information. The Paged data structure wraps the items in the response and provides a uniform interface to the paged information.
| Name | Description | Value |
|---|---|---|
| items | the items in this page; the type of the items will of course vary by method | array of objects |
| page | the 0-indexed page number that this result represents | number |
| pageSize | the number of items allowed per page when generating this result; the actual number of items on this page may be less than or equal to this number | number |
| total | the count of items on all pages; using this and pageSize, it is possible to calculate the total number of pages | number |