Site Search APIs use a small set of shared pagination patterns. Use this article to identify the pagination model for an endpoint family, then apply the endpoint-specific parameter and response-field details in that endpoint article.
Pagination Models Used in Site Search APIs
| Model | Parameters | Typical Response Fields | Where Used |
|---|---|---|---|
| Offset-based |
start, rows
|
numFound, start, docs
|
Search endpoints |
| Offset-limit |
offset, limit
|
Endpoint-specific arrays and metadata | Reporting API |
| Not applicable | N/A | N/A | APIs that do not return paged result sets, such as ingest, tracking, geocoding, and smart answers |
Pagination Behavior Notes
- For endpoints with pagination, each endpoint article lists the request parameters and response metadata.
- Deep pagination is not a supported pattern in Site Search API docs. Use documented first-page and nearby-page retrieval patterns, and validate larger offsets in your app before relying on them.
- For endpoints without pagination, the article marks pagination as not applicable.
- When pagination behavior varies by endpoint, known constraints are called out in that endpoint article.