Download a data index export as NDJSON

get

https://api.controlup.com/edge/api/data/{index_name}/export.ndjson

Streams the matching documents as application/x-ndjson, one JSON object per line with no wrapping array. The X-Export-Limit, X-Total-Available and X-Export-Truncated headers are sent before the first byte of the body. The page_size and cursor parameters are not supported on this endpoint.

Path Params

index_name

string

required

The name of the data index to export.

Query Params

limit

integer

The maximum number of documents to stream. The value is capped by the per-index export limit, and the full limit is used when omitted.

fields

string

A comma-separated list of the fields (columns) to return. All fields are returned when omitted. For CSV exports this also sets the header row.

sort

string

The sort field and direction, as field:direction. A _doc:asc tiebreaker is always appended so that paging is stable.

query

string

A JSON-encoded OpenSearch query DSL object used to filter the exported documents.

include_scores

boolean

Defaults to false

Sets whether the _score field is kept on each returned document.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The export stream, one JSON document per line.

400The index name, query, cursor, or a query parameter is invalid.

401The user access token (or API key) was invalid or not provided.

429The tenant already has the maximum number of concurrent streaming exports in progress.

503The pagination session store is unreachable, so cursors cannot be issued or resolved.