{{ summaryTitle }} {{ summaryValue }} {{ summaryLine }} {{ badge.label }} {{ badge.value }}
Collection Pages Workers API
API pagination window setup
Collection and request timing inputs
Select the request pattern used by the endpoint or export job.
A zero-item collection produces zero page requests.
The endpoint cap below is applied before page count is calculated.
items/page
A positive cap prevents the plan from assuming an invalid request size.
items/page
Concurrency does not raise this global request ceiling.
req/min
Use a measured average or a conservative staging sample.
ms/page
Use the maximum page requests this job can keep in flight at once.
workers
Divide a representative response payload by its returned item count.
bytes/item
{{ workflowFeedback }}
Leave blank for the neutral label API collection.
Use kibibytes per page after the same encoding/compression basis as item size.
KiB/page
Use evidence from retry and throttling logs; this is a time reserve, not a retry-count guarantee.
%
{{ tableExportStatus }}
MeasureValuePlanning basisCopy
{{ row.label }}{{ row.value }}{{ row.note }}
{{ tableExportStatus }}
CheckStateRecommended actionCopy
{{ row.label }}{{ row.state }}{{ row.action }}
{{ chartExportStatus }}

Large API collections rarely arrive in one response. Pagination divides them into bounded requests so clients can control memory, response time, retries, and service load. The cost is a retrieval window made from many small waits, plus enough state to resume without skipping or repeating items.

Page size changes several parts of that tradeoff at once. Larger pages usually mean fewer requests and less repeated response overhead, but each response is heavier and may take longer to process or retry. Smaller pages reduce the work lost to one failed request, yet can spend more time against a request-rate ceiling.

Common API pagination styles and their operational concern
Pagination styleContinuation stateMain concern
Cursor or next tokenOpaque value returned by the servicePersist the token only after the page is processed.
Offset and limitNumeric positionDeep offsets and changing collections can be slow or unstable.
Page numberPage indexConfirm whether numbering starts at zero or one.
Keyset or seekLast stable sort keyUse a deterministic tie-breaker when keys repeat.
Incremental checkpointTime, sequence, or high-water markDefine overlap and deduplication before resuming.

Throughput is constrained by whichever is slower: the global request allowance or the time workers spend waiting for pages. Adding workers helps only while page latency is the limiter. Once the rate ceiling is slower, more concurrency cannot shorten the modeled window unless the available request allowance also rises.

A planning estimate is only as good as its observations. Average page latency should include service processing and transfer time. Average item size should come from representative serialized responses, using the same fields, encoding, and compression basis expected in the real job. Shared rate limits must be reduced by traffic that other clients will consume.

Pagination mechanics also affect correctness. Stable filtering and ordering, idempotent processing, bounded retries, and durable continuation state matter more than a fast estimate if the collection changes during the run. The window predicts elapsed time and payload under fixed assumptions; it does not guarantee a complete export without duplicates.

How to Use This Tool:

Use the documented endpoint limits and a measured page sample from the same collection you plan to retrieve.

  1. Choose the Pagination style, then enter Total items, the requested Page size, and any positive Endpoint page cap. A cap of zero means no cap is known.
  2. Enter the Request allowance, representative Average page latency, and the number of page requests the job can keep in flight as Concurrent workers.
  3. Estimate Average item size. Add per-page response overhead and an evidence-based retry-time reserve in Advanced when wrappers, throttling, or transient failures materially affect the run.
  4. Review Pagination window plan for requests, elapsed time, payload, and active limiter. Use Operating checks to verify the continuation method, then compare nearby sizes in Page size sensitivity.

Interpreting Results:

The modeled retrieval window is the slower of the rate-limit and latency windows, increased by the retry reserve. The Active limiter tells you which constraint currently controls elapsed time.

  • If the endpoint cap is applied, plan with the effective page size rather than the larger requested value.
  • If rate limit is active, extra workers do not improve the estimate. If page latency is active, a measured increase in concurrency may help until the rate ceiling takes over.
  • Payload is an uncompressed arithmetic estimate unless the entered item and overhead sizes already reflect compression. It does not include local indexes, transformed records, or downstream storage amplification.
  • The sensitivity series changes page size while holding all other assumptions fixed. A lower modeled time does not override the endpoint's documented maximum or safe response size.

Technical Details:

The model treats pagination style as an operational choice, not a timing multiplier. Cursor, offset, page-number, keyset, and incremental modes use the same page-count and throughput equations; their different continuation risks appear in the operating guidance.

Formula Core

First apply a positive endpoint cap to the requested size. Page requests round upward so a partially filled final page still counts as one request.

Seffective={Srequestedif cap = 0min(Srequested,Scap)if cap > 0 P=NSeffective Trate=P×60R Tlatency=PC×L1000 Ttotal=max(Trate,Tlatency)×(1+Q100)

Here, N is total items, P is page requests, R is requests per minute, C is concurrency, L is average milliseconds per page, and Q is retry reserve percent. A zero-item collection is a special case with zero requests and zero elapsed time.

Payload combines item bytes with fixed overhead for every page:

Payload bytes=N×B+P×H×1024

B is average bytes per item and H is response overhead in kibibytes per page. Effective item rate is total items divided by the reserved retrieval window.

Validation and boundaries

The sensitivity series tests approximately one-quarter, one-half, the current size, twice the current size, and four times the current size. Values are deduplicated, kept at one item or more, and never allowed above a positive endpoint cap.

Item count may be zero, but page size must be a positive whole number. A known cap is also a whole number; zero disables cap adjustment. Request allowance must stay above zero, concurrency must be at least one, latency and size estimates cannot be negative, and retry reserve accepts 0% to 300%. At 5 GiB or more, the operating guidance prompts a separate check of streaming, compression, storage, and resumability; 5 GiB is a planning cue rather than an endpoint limit.

Accuracy Notes:

The estimate assumes a fixed total item count, average latency, available request allowance, and worker count. Adaptive throttling, token expiry, changing collections, uneven final pages, client-side processing, network congestion, retries with backoff, and provider-side page reductions can all change real elapsed time. Measure a staging run and keep continuation state durable before relying on the full-run window.

Worked Examples:

Rate-limited order backfill

A collection of 125,000 items at 500 items per page needs 250 requests. With 480 requests per minute, four workers, and 180 ms average latency, the rate window is 31.25 seconds while the latency window is 11.34 seconds. The modeled window is therefore 31.25 seconds before retry reserve, and adding workers alone cannot reduce it.

References: