Optional
cursorOptional
dataContains the result data.
Optional
limitMaximum number of results returned based on the limit
specified in the request. For example, if there are 20
results, the request has no cursor
value, and the limit
is set to 20
,the size
of the results will be 20
. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the cursor
parameter value that you obtained from the response.
Optional
linksOptional
sizeNumber of results returned in the response considering the cursor
and the limit
values sent in the request. For example, if there are 20
results, the request does not have a cursor
value, and the limit
set to 10
, the size
of the results will be 10
.
In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection.
Optional
totalTotal number of results available. If the value of the total
parameter is higher than the value of the size
parameter, this means that there are more results that you can retrieve. To retrieve more results, you can make another request and set the offset
value accordingly. For example, if there are 30
results, and the request has the offset
set to 0
and the limit
set to 20
, the size
parameter will return 20
and the total
parameter will return 30
. This means that there are 9 more results to retrieve (as the offset is zero-based).
A cursor-paginated method returns a portion of the total set of results based on the
limit
specified and acursor
that points to the next portion of the results. To retrieve the next set of results of the collection, set thecursor
parameter in your next request to the value returned in this parameter.