Export a data index page by page

post

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

Returns a page of documents from a data index using cursor-based pagination. Send the next_cursor value from the previous response as the only body property to retrieve the next page. When cursor is set, all other body properties are ignored.

Path Params

index_name

string

required

The name of the data index to export.

Body Params

query

object

An OpenSearch query DSL object used to filter the exported documents. Defaults to matching every document.

fields

array of strings

The fields (columns) to return. All fields are returned when omitted.

fields

sort

array of strings

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

sort

include_scores

boolean

Defaults to false

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

page_size

integer

Defaults to 1000

The number of documents returned per page. The value is capped by the per-index limit, which is between 100 and 1000 depending on the index.

cursor

string

The next_cursor value from the previous response. When this property is set, all other properties are ignored.

Responses

200A page of documents from the data index.

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

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

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