GeoSearchPagination
Pagination parameters for geo location search requests and responses.
Declaration
object GeoSearchPaginationProperties
| Name | Type | Description |
|---|---|---|
totalCount | int64 | Total number of results matching the search criteria. Present in the response only. Read-only. |
offset | int32 | Zero-based index of the first result to return. Defaults to |
pageSize | int32 | Maximum number of results to return per page. Defaults to |
Discussion
The GeoSearchPagination object controls and reports offset-based pagination through geo location search results.
When used in a GeoSearchPostRequest body, set offset and pageSize to retrieve a specific page of results. The GET endpoint (GET /v1/search/geo (Search Geo Locations)) accepts offset and pageSize as query parameters instead of a request body. In both cases the response pagination object includes totalCount, enabling callers to calculate the total number of pages available.
The default pageSize of 20 is sufficient for most targeted lookups. Increase it for searches expected to return many matching locations. To retrieve the next page, increment offset by pageSize.
Example
{
"totalCount": 87,
"offset": 20,
"pageSize": 20
}