PageInfo

  • Paging in list operations returns only one page of results.

  • The PageInfo message describes the returned page with fields like totalResults, resultPerPage, and startIndex.

  • totalResults indicates the total number of available results, resultPerPage shows the number of results in the current response, and startIndex is the index of the first result on the page.

Information about the current page.

List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned.

JSON representation
{
  "totalResults": integer,
  "resultPerPage": integer,
  "startIndex": integer
}
Fields
totalResults

integer

Total number of results available on the backend ! The total number of results in the result set.

resultPerPage

integer

Maximum number of results returned in one page. ! The number of results included in the API response.

startIndex

integer

Index of the first result returned in the current page.