arrow-right-arrow-leftPagination

How to page through list endpoint results using limit and offset query parameters.

List endpoints in the Platform API support pagination through limit and offset query parameters. These parameters let you control the number of results returned and page through large data sets.

Parameters

Parameter
Type
Default
Description

limit

integer

Varies by endpoint

Maximum number of items to return. Must be >= 1. Upper bound varies by endpoint.

offset

integer

0

Number of items to skip before returning results. Must be >= 0.

Both parameters are optional. Omitting them returns the default result set, which matches the behavior prior to pagination support.

Example

# First page of 25 results
curl -H "Authorization: Bearer $API_KEY" \
  "https://api.platform.amigo.ai/v1/metrics?limit=25&offset=0"

# Second page
curl -H "Authorization: Bearer $API_KEY" \
  "https://api.platform.amigo.ai/v1/metrics?limit=25&offset=25"

Supported Endpoints

The following endpoint groups support limit and offset:

Endpoint Group
Default Limit
Max Limit

Audit exports

50

200

Entity duplicates

100

500

Intake links

100

500

Intake uploads (per link)

200

500

Integrations (internal)

500

1000

Skills (internal)

500

1000

Metrics

100

500

Voice judge results

20

100

Entity enrichment values

200

500

Enrichment keys

200

500

M42 district metrics

20

500

M42 anomaly alerts

20

500

M42 forecast fan

1000

5000

M42 positive signals

20

200

M42 ranked anomalies

20

500

M42 cluster summary

20

500

M42 cluster forecast

1000

5000

M42 model registry

20

500

M42 stratified fits

20

500

M42 patient labs

500

2000

Validation

Requests with limit or offset values outside the allowed range receive a 422 Unprocessable Entity response. The limit must be at least 1 and at most the endpoint's maximum. The offset must be non-negative.

Notes

  • Result ordering is preserved as documented for each endpoint. Pagination slices the ordered result set.

  • If offset exceeds the total number of available results, an empty list is returned.

  • Total count headers are not currently included in responses. To detect the end of a result set, check whether the number of returned items is less than the requested limit.

Last updated

Was this helpful?