Search

Export search results as CSV (streaming)

Exports the current search results as a streaming CSV download. The response is streamed directly to the client without buffering the entire result set in memory.

get/v1/search/export

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/search/export
  • Auth: HTTP bearer

Query parameters

qstring

Search Query Text

indexstring

ElasticSearch Index name, defaults to table

deletedboolean

Filter documents by deleted param. By default deleted is false

query_filterstring

Elasticsearch query that will be combined with the query_string query generator from the query argument

post_filterstring

Elasticsearch query that will be used as a post_filter

sort_fieldstring

Sort the search results by field

sort_orderstring

Sort order asc for ascending or desc for descending, defaults to desc

sizeinteger

Maximum number of rows to export. When null, exports all matching results up to the hard cap.

frominteger

Starting offset for export. Use with size to export a specific page of results (e.g., from=30&size=15 for page 3).

Response

CSV file stream

Changes

No recorded changes to this operation across all 1 revision of this API.