For queries that return large result sets, the API uses offset-based pagination with skip and limit request attributes.
skipspecifies how many items to offset (skip) from the beginning of the result set.limitspecifies the maximum number of items to return in a single request.
Defaults and limits:
- Default page size varies by dimension. Default for time dimension is 1500 items. All other dimensions default to 10 items.
- Maximum
limitis 1500 for the time dimension and 1000 for all other dimensions.
How pagination works:
- Start with
skip=0and a desiredlimit(for example,limit=1000). - Retrieve the next page by increasing
skipby the value oflimit: - First page:
skip=0,limit=1000 - Second page:
skip=1000,limit=1000 - Third page:
skip=2000,limit=1000 - Continue paging until fewer items than the specified
limitare returned.
Additional details:
- The response includes a
paginationobject containing the total number of available items. - Results can be sorted using the
sortparameter, for exampletime:ascortime:desc. For consistent pagination, use a deterministic sort order.