In-depth practical guides

Check API pagination

Separate successful responses from complete collection and reconcile cursors and retrieved identifiers.

Updated :

Ethernet switch and network cables. Illustrative scene.

AI-generated illustration · Ethernet switch and network cables. Illustrative scene.

Did you obtain every expected page?

A 200 response may contain only the first page. Pagination can use a page number, offset, cursor or next link. This guide provides a reproducible collection check; the exact mechanism comes from the service documentation.

  1. Fix scope

    Keep query, filters, version and sort order. Record the announced total and whether it counts records, estimated results or distinct objects. Compare equivalent filters.

  2. Follow documented continuation

    Read the supplied next link or cursor. Log every transition and detect previously visited continuations. Do not invent addresses when the service supplies its own.

  3. Reconcile counts

    Count received records and unique identifiers separately. Overlapping pages inflate record totals. Retain repeated objects to inspect their versions before deduplication.

  4. Document the stop

    Record declared end, collection cap, error or interruption. For changing data, use a snapshot when available or disclose the limitation. Resume with unchanged filters.

Situations and decisions

Typical situations for preparing a check. They do not describe completed assignments or actual observations.

Two pages of 100 records

Fictional case: 200 records but 190 unique identifiers. Investigate overlap or updates before claiming 200 objects; repetition alone does not establish a provider error.

A cursor returns to the start

Illustrative case: a previously seen continuation reappears. Stop and retain the trace. A loop is not evidence of exhaustive collection.

Record to retain

  • Query, filters and version
  • Page transitions and responses
  • Raw and unique counts
  • Stop reason and resume conditions

Official references

Related source profiles

Related protocols

Checks before reaching a conclusion

  • Are filters stable?
  • Are continuations unique?
  • Are repetitions explained?
  • Is the stopping reason explicit?

A collection log separating technical success, observed coverage and interrupted collection.

Frequently asked questions

Does a short final page suffice?

Only if the service contract says so. Filters or changing data can also shorten pages. Use the documented end signal.

Why retain repeated records?

They reveal overlap and version changes. Immediate removal can hide the cause or discard a useful observation.

TOOLS / REGISTERS

Write a record

Totals may be estimates or change during collection. A next link does not override quotas or documented access conditions.

  • Access date and time zone
  • Exact URL
  • HTTP status / redirect
  • Received continuation / cursor
  • Received record count
  • Distinct received identifiers
  • Version / revision
  • Limit / uncertainty
  • Decision / next action
  • Review owner
  • Next review