Contents

QueryPaginationResult

Pagination metadata returned in query responses, including page size, offset, and optional total count.

Declaration

object QueryPaginationResult

Properties

NameTypeDescription
pageSizeint32

The page size for this response.

offsetint32

The offset position for this response page.

totalCountint64

The total number of results matching the query. Only populated when fetchTotalCount is true in the request.

Discussion

The QueryPaginationResult object is returned in the pagination field of query responses. It echoes the pageSize and offset from the request and provides totalCount when requested. To calculate the total number of pages, use totalCount with pageSize.

Example

{
  "pageSize": 20,
  "offset": 0,
  "totalCount": 137
}

See Also

Query Objects