Request Parameters

The API supports pagination through the following query parameters:

Parameter	Type	Description	Range	Default
page	integer	Page number (zero-indexed)	0 to 1000	0
pageSize	integer	Number of items per page	10 to 100	10

Example Request

GET /api/segments?page=2&pageSize=50

Response Structure

{
  "segments": [ ... array of items ... ],
  "page": 2,
  "pageSize": 50,
  "hasMore": true
}

Response Fields

Field	Type	Description
segments	array	Array of segments items
page	integer	Current page number (reflects the request)
pageSize	integer	Number of items per page (reflects the request)
hasMore	boolean	Indicates if more pages are available

Notes

• If page is out of range (> 1000 or negative), the API will return a 400 Bad Request error.
• If pageSize is out of range (< 10 or > 100), the API will return a 400 Bad Request error.
• For pages beyond available data, an empty "data" array is returned with hasMore set to false.
• The hasMore flag helps clients determine if there are more pages to fetch without needing to know the total number of items or pages.

Example Scenarios

1. More data available

{
  "segments": [ ... 50 items ... ],
  "page": 2,
  "pageSize": 50,
  "hasMore": true
}

2. Last page with data

{
  "segments": [ ... 20 items ... ],
  "page": 5,
  "pageSize": 50,
  "hasMore": false
}

3. Beyond available data

{
  "segments": [],
  "page": 10,
  "pageSize": 50,
  "hasMore": false
}