Compare commits

...

1 Commits

Author SHA1 Message Date
Ubuntu
59e5c43013 docs: document offset pagination for export_raw_data API
Expand the POST /api/v1/export_raw_data endpoint description to cover
client-controlled offset pagination, the limit defaults/cap, the
non-negative offset validation, and the empty-result termination
condition. Spec-only change; the SigNoz docs site auto-renders the
API Reference from this file.

Source PRs: #11825

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 12:10:12 +00:00

View File

@@ -9907,8 +9907,19 @@ paths:
/api/v1/export_raw_data:
post:
deprecated: false
description: This endpoints allows complex query exporting raw data for traces
and logs
description: |
Exports raw data for traces and logs using a query builder spec.
Pagination: set the `offset` field in a query spec to control the starting
row. The export begins at `offset` (default `0`) and returns up to `limit`
rows (default `10000`, max `50000`). To page through a large dataset, keep
`limit` fixed and increase `offset` by `limit` on each successive request;
stop when a response returns fewer rows than `limit`. An `offset` beyond the
available rows returns an empty result set, which signals the end of the
data. A negative `offset` is rejected with `400 Bad Request` and the message
`offset must be non-negative`. The per-request row cap (`50000`) applies to
each call independently; there is no cap on the total rows retrieved across
paginated requests.
operationId: HandleExportRawDataPOST
parameters:
- description: The output format for the export.